General Explanation
Uri
1
https://monitor.voicenter.co.il/Comet/api/GetExtensions
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" |
| "showAll" | "Allows to set if the return extensions list by the organization hierarchy. If you wish to get all the extensions data in the all organization or only for a specific department. If this field is not sent in the request, the API will return all extensions in the organization. \"False\" or \"0\" – Returns all extension in a specific department. You will need to receive the \"Code\" identifier for each department you wish to use. \"True\" or \"1\" – Returns all extension in the organization." | "Boolean" | "Optional" |
Client Request Example (GET)
1
https://monitor.voicenter.co.il/Comet/api/GetExtensions?code=XXXXXXXXXXXXXXX&showAll=0
Client Request Example (POST - JSON)
{
"code": "XXXXXXXXXXXXXXX",
"showAll": 0
}
Voicenter Response Parameters
| Field name | Description | Type |
| "ERR" | "Response status: \"0\" – No errors. \"1\" – The sent request Code format is invalid. * In case the sent \"Code\" value is invalid you will simply get an empty \"EXTENSIONS\" array response." | "Integer" |
| "DESC" | "Response status description: \"OK\" – No errors. \"Unauthorized\" - The Code value or format is invalid." | "String" |
| "EXTENSIONS" | "A list of the requested extensions data." | "Array" |
| "SIP" | "The extension’s personal identifier. The SIP user code." | "String" |
| "Name" | "The extension’s name (as it appear in the Voicenter Cpanel)." | "String" |
| "SpeedDial" | "The extension’s personal speed dial. Speed dial – a short phone number for internal communication between the organization extensions." | "String" |
| "AccountID" | "The department that the extension is set on personal identifier(as it appear in the Voicenter Cpanel)." | "Integer" |
| "AccountName" | "The department that the extension is set on name (as it appear in the Voicenter Cpanel)." | "String" |
| "UserName" | "The user that the extension is set on name (as it appear in the Voicenter Cpanel)." | "String" |
| "UserEmail" | "The user that the extension is set on email field (as it appear in the Voicenter Cpanel)." | "String" |
Voicenter Response Example
{
"ERR": 0,
"DESC": "OK",
"EXTENSIONS": [
{
"SIP": "SIPSIP1",
"Name": "Extension 1",
"SpeedDial": "11",
"AccountID": 12345678,
"AccountName": "Voicenter Account",
"UserName": "John Doe",
},
{
"SIP": "SIPSIP2",
"Name": "Extension 2",
"SpeedDial": "12",
"AccountID": 12345679,
"AccountName": "Sales Department",
"UserName": "Walter Melon",
}
]
}