Groups
Actions for getting information on groups and members. Actions for logging in/out members. Note: Standard users are only allowed to login/out them self. Admin users can logg in/out all members.
| NetPBX Web API | Description |
|---|---|
| GET api/v1/groups |
Get all groups in the tenant |
| GET api/v1/groups/{groupid} |
Get a specific group |
| GET api/v1/groups/{groupid}/members |
Get all members of a group |
| PUT api/v1/groups/{groupid}/members/{memberid} |
Logg in/out member to/from the group |
Users
Actions for getting information on users. Actions for setting properties on users. Note: Users group status can be retreived and altered through the group methods. UserId and Group MemberId refer to the same user. Standard users are only allowed to Update them self. Admin users can Update all users.
| NetPBX Web API | Description |
|---|---|
| GET api/v1/users |
Get all users in the tenant |
| GET api/v1/users/{userid} |
Get a specific user |
| GET api/v1/users/email?email={email} |
Get a specific user by email |
| GET api/v1/users/extension?extension={extension} |
Get a specific user by extension |
| PUT api/v1/users/{userid}/name |
Update a user first / last names |
| PUT api/v1/users/{userid}/email |
Update a user email |
| PUT api/v1/users/{userid}/mobilenumber |
Update a user mobile number (Not affecting MEX users). Format E.164 (+46701234567) |
Authorizations
Actions for logging in users and to get information on the currently logged in user. The POST action can be used to retreive the api token.
| NetPBX Web API | Description |
|---|---|
| GET api/v1/authorizations |
Get the current user corresponding to the api_token |
| POST api/v1/authorizations |
Login and return current user including user api token. Currently only standard users and tenant admins are supported |
QueuePulses
Actions to get queue and member status on groups. Note: Queue status information is only supported for groups with queue: Hunt group with queue, ACD group, Attendant group, Customer center group. Wrap up (clerical) time is only supported by customer center group.
| NetPBX Web API | Description |
|---|---|
| GET api/v1/queuepulses |
Get queue pulse info on all groups in the tenant |
| GET api/v1/queuepulses{groupid} |
Get queue pulse info on a specific group |