General Explanation
The active calls API gives you a clear picture of how many active calls your organization currently have and/or how many calling clients are currently waiting in your queue/s.
You can also perform your own dedicated popup with this api when an agent answer and call they press a button in your crm system which triggers an api reqeust to Voicenter Active Calls api.
GetExtensionsCalls
Returns data by a specific extension or all extensions in your call center.
URI
1
https://monapisec.voicenter.co.il/comet/API/GetExtensionsCalls
Acceptable Request Types
1. POST-JSON
2. GET
Possible Response Formats
1.POST-JSON
Client Request Parameters
| Field name | Description | Type | Remarks |
| "code" | "Personal identifier, provided by Voicenter." | "String" | "Mandatory" |
| "extension" | "In case you wish to get result for a specific extension. Extension SIP identifier, provided by Voicenter. If this field is not sent in the request, the API will return all extensions data." | "String" | "Optional" |
Client Request Example (GET)
1
https://monapisec.voicenter.co.il/comet/API/GetExtensionsCalls?code=XXXXXXXXXXXXX&extension=SIPSIP
Client Request Example (POST - JSON)
{
"code": "XXXXXXXXXXXXX",
"extension": "SIPSIP"
}
Voicenter Response Parameters
| Field name | Description | Type |
| "ERR" | "Response status: \"0\" – No errors. \"1\" – The request format is invalid. \"2\" – Either the sent parameters values are incorrect or Voicenter internal issue." | "Integer" |
| "DESC" | "Response status description: \"OK\" – No errors. \"Authorization failed.\" - The request format is invalid. \"Internal error.\" – Either the sent parameters values are incorrect or Voicenter internal issue." | "String" |
| "EXTENSIONS" | "JSON array type. List of the requested extensions." | "Array" |
| "name" | "The Voicenter user name that the extension is associated with." | "String" |
| "userID" | "The Voicenter user ID that the extension is associated with." | "Integer" |
| "representative" | "The Voicenter user name that is currently logged in to the extension." | "String" |
| "onlineUserID" | "The Voicenter user ID that is currently logged in to the extension." | "Integer" |
| "username" | "The extension unique SIP code identifier." | "String" |
| "onlineUserStatus" | "The user status that is currently logged into the extension: \"1\" – Login. \"2\" – Logout. * \"3\" – Lunch. \"5\" – Administrative. \"7\" – Private. \"9\" – Other. \"11\" – Training. \"12\" - Team meeting. \"13\" – Brief. *Logout is the default status that is return in case there is no logged in user on an extension." | "Integer" |
| "calls" | "JSON array type. Displays the currently active calls at the extension." | "Array" |
| "callStarted" | "The time that the call started in EPOCH time." | "Integer" |
| "callAnswered" | "The time that the call was answered in EPOCH time. In case the call was not answered yet, it will return \"0\"." | "Integer" |
| "answered" | "Was the call answered? \"0\" – No (or not yet). \"1\" – Yes." | "Integer" |
| "callername" | "Caller name that is shown at the destination phone (Supported only for Voicenter extensions)." | "String" |
| "callerphone" | "Caller caller ID." | "String" |
| "callstatus" | "The call status: \"Ringing\" – An incoming call is currently ringing at the extension. \"Dialing\" – In case the extension is making an outgoing call and the call was not answered yet. \"Talking\" – There is an ongoing conversation at the extension (an incoming or outgoing call). \"Hold\" – In case the call was put on \"Hold\"." | "String" |
| "customdata" | "JSON array type. Displays custom data that was sent to Voicenter. In addition, if a specific call has an origin call it will display here with the field name \"OriginalIvrUniqueID\". For example: if a call was first answered by one representative who then transferred it to another representative. The second part of the call that was transferred, will have in the \"CustomData\" field a ivrid value of the original call, thus associating both calls." | "Array" |
| "direction" | "General call direction: \"Incoming\". \"Outgoing\"." | "String" |
| "ivrid" | "Displays the ID code of the specific call. Unique identifier." | "String" |
| "recording" | "JSON array type. Displays the call recording data." | "Array" |
| "Filename" | "The recording file name." | "String" |
| "IsMuted" | "Displays if the current conversation in now recorded? \"0\" – Not muted. The conversation is now being recorded. \"1\" – Muted. The conversation is not being recorded now. With Mute Call API you can control which part of a call will be recorded." | "Integer" |
| "did" | "In case of an incoming call, displays the phone number that the caller dialed to." | "String" |
Voicenter Response Example
{
"ERR": 0,
"DESC": "OK",
"EXTENSIONS": [
{
"name": "User 1",
"representative": "User 1",
"username": "SIPSIP1",
"extensionID": 875756567,
"userID": 6946792,
"onlineUserID": 0,
"onlineUserStatus": 2,
"calls": [
]
},
{
"name": "User 2",
"representative": "User 2",
"username": "SIPSIP2",
"extensionID": 97483478,
"userID": 46454322,
"onlineUserID": 46454322,
"onlineUserStatus": 1,
"calls": [
{
"callStarted": 1602465818,
"callAnswered": 1602465819,
"answered": 1,
"callername": "Voicenter",
"callerphone": "0722776772",
"callstatus": "Talking",
"customdata": {
},
"direction": "Outgoing",
"ivrid": "2020101201cc7b38df",
"recording": {
"Filename": "2020101201cc7b38df-aws-SIPSIP2-972722776772.mp3",
"IsMuted": 0
},
"did": ""
}
]
}
]
}
GetQueuesCallers
Returns data by a specific queue or all queues in your call center.
URI
1
https://monapisec.voicenter.co.il/comet/API/GetQueuesCallers
Acceptable Request Types
1. POST - JSON
2. GET
Possible Response Formats
1. POST-JSON
Client Request Parameters
| Field name | Description | Type | Remarks |
| "code" | "Personal identifier, provided by Voicenter." | "String" | "Mandatory" |
| "queue" | "In case you wish to get result for a specific queue. Queue ID identifier, provided by Voicenter. If this field is not sent in the request, the API will return all queues data." | "String" | "Optional" |
Client Request Example (GET)
1
https://monapisec.voicenter.co.il/comet/API/GetQueuesCallers?code=XXXXXXXXXXXXX&queue=XXXXXXXXX
Client Request Example (POST - JSON)
{
"code": "XXXXXXXXXXXXX",
"queue": "XXXXXXXXX"
}
Voicenter Response Parameters
| Field name | Description | Type |
| "ERR" | "Response status: \"0\" – No errors. \"1\" – The request format is invalid. \"2\" – Either the sent parameters values are incorrect or Voicenter internal issue." | "Integer" |
| "DESC" | "Response status description: \"OK\" – No errors. \"Authorization failed.\" - The request format is invalid. \"Queue is not found in this account\" – In case the queue field value is incorrect. \"Internal error.\" – Either the sent parameters values are incorrect or Voicenter internal issue." | "String" |
| "QUEUES" | "JSON array type. List of the requested queues." | "Array" |
| "Name" | "The queue name." | "String" |
| "ID" | "The queue ID." | "Integer" |
| "Weight" | "The current queue weight configuration." | "Integer" |
| "Callers" | "JSON array type. Displays the active calls at the queue." | "Aray" |
| "Phone" | "Caller caller ID." | "String" |
| "CallID" | "Displays the ID code of the specific call. Unique identifier." | "String" |
| "JoinTime" | "The time that the call entered the queue in EPOCH time." | "Integer" |
| "Duration" | "The time that the call is currently waiting in the queue in Seconds." | "Integer" |
Voicenter Response Example
{
"ERR": 0,
"DESC": "OK",
"QUEUES": [
{
"Name": "QUEUE 1",
"ID": 12345678,
"Weight": 5,
"Callers": [
{
"Phone": "0722776772",
"CallID": "202010131430590714966",
"JoinTime": 1602599565,
"Duration": 21
},
{
"Phone": "0501234567",
"CallID": "202010131433000d14cc4b",
"JoinTime": 1602599583,
"Duration": 3
}
]
},
{
"Name": "QUEUE 2",
"ID": 87654321,
"Weight": 0,
"Callers": [
]
}
]
}