From Bright Pattern Documentation
• 3.18
Contents
- Introduction
- API Specification
- Clear User Lock State
- Create User
- Export Access Numbers
- Export User Phone Numbers
- Get User Data
- Get User Lock State
- Update User
- 1 Get All Users
User Management API Specification
Get All Users
Gets all data for users.
Request
URL
http[s]://<host>/configapi/v2/phone/user
HTTP Method
GET
Response
Body
Access number data (content-type: application/JSON)
Example
[ { "login_id" : "kelli.simmon", "extension": "2021", "firstName": "Kelli", "lastName": "Simmon", "external": "1234567889", "voiceMail": false, "greeting": fals }, { "login_id" : "ajenks", "extension": "2022", "firstName": "Alan", "lastName": "Jenks", "external": "1234567890", "voiceMail": true, "greeting": true }, { "login_id" : "tony.cobb", "extension": "2023", "firstName": "Tony", "lastName": "Cobb", "external": "1234567889", "voiceMail": false, "greeting": false } ]
Parameters
Parameters | Data Type | Description |
login_id | String | The user's login |
extension | Integer | The phone extension of the user |
firstName | String | The user's first name |
lastName | String | The user's last name |
external | Integer | Access number associated with the given extension (i.e., an external number assigned to this user for direct inward dialing (DID)) |
voiceMail | Boolean | Indicates whether this user has the voicemail function enabled |
greeting | Boolean | Indicates whether this user has a voicemail greeting set up |