api:pbx:app:mobileconfig:list
Table of Contents
API : PBX : APP : Mobile Config List
Introduction
This request will return the list of mobile configs for customer.
Mobile configs are used for communicator mobile app.
Request
| URL | https://api.telecomx.dk/pbx/app/mobileconfig | |
|---|---|---|
| Method | GET | |
| Access level | VIEWER, MANAGER, OWNER if fetching customers mobile configs RESELLER if fetching a customers mobile configs ADMIN. |
|
| Query | employee | [optional] Id of employee to exclude from list, this lists only configs to copy from. Defaults to user self. |
| customer | [optional] Id of customer. If set and user is at least MANAGER, then a complete list of employees and their dashboards are returned. |
|
Query examples
https://api.telecomx.dk/pbx/app/mobileconfig?employee=12345678901234567890ABCD&customer=1234567801234567890AAAA
Response
Array of JSON objects.
| JSON object | ||
|---|---|---|
| _id | Id | Id of mobile config. |
| customer | id | Id of the customer. |
| configs | Array | List of configs |
| configs[].type | String | Type of config |
| configs[].items | Array | List of items |
| configs[].items[]._id | Id | Object id of item |
| configs[].items[].name | String | Name of item |
| configs[].others | Array | List of items |
| configs[].others[]._id | Id | Object id of item |
| configs[].others[].name | String | name of object |
Example
[ { "_id": ObjectId("12345678901234567890ABCD"), "customer": ObjectId("12345678901234567890AAAA"), "configs": [ { "type": "COLLEAGUES", "items": [ { _id: "12345678901234567890EEEE", "name": "Joakim" } ], "others": [ { "_id": "12345678901234567890FFFF", "name": "Per" } ] }, { "type": "QUEUES", "items": [ { "_id": "12345678901234567890EEEE", "name": "Support" } ], "others": [ { "_id": "12345678901234567890FFFF", "name": "Vagt" } ] }, { "_id": ObjectId("12345678901234567890ABCD"), "customer": ObjectId("12345678901234567890AAAA"), "configs": [ { "type": "COLLEAGUES", "items": [ { _id: "12345678901234567890EEEE", "name": "Joakim" } ], "others": [ { "_id": "12345678901234567890FFFF", "name": "Per" } ] }, { "type": "QUEUES", "items": [ { "_id": "12345678901234567890EEEE", "name": "Support" } ], "others": [ { "_id": "12345678901234567890FFFF", "name": "Vagt" } ] } ]
Errors
| Error code | Message | Description |
|---|---|---|
| 400 | bad_request | Request not valid |
| 403 | access_denied | Insufficient access level |
| 404 | not_found | Object not found |
| 500 | internal_error | <Unspecified> |
api/pbx/app/mobileconfig/list.txt · Last modified: 2024/11/08 10:47 by Gudni Sigurdsson