API : PBX : Phonebook groups
A phonebook group is a named group of phonebook contacts. Other features point at a group by its id, e.g. to route a call depending on whether the caller is in the group.
There are two kinds of groups:
- Customer groups hold the customers shared contacts. Every user of the customer can see them. Access level MANAGER or above is required to create, rename and delete them.
- Personal groups belong to one employee and hold that employees personal contacts. The employee manages them, and so does another employee who has the group right
readPhonebook(to see them) orwritePhonebook(to change them) on the employee.
A contact selects its groups through its groups property when it is created or updated. A shared contact can only be in customer groups, a personal contact only in the personal groups of its own employee. A contact can be in at most 100 groups, and everybody who may change a contact may change its groups.
Group names are unique (not case sensitive) among the customer groups, and among the personal groups of each employee. A personal group may have the same name as a customer group.
| API | Description |
|---|---|
| List | List groups with the number of contacts in each |
| Get | Get a single group |
| Create | Create a customer group or a personal group |
| Update | Rename a group or change its notes |
| Delete | Delete a group - it is first taken out of every contact in it |
The phonebook list can be filtered on a group with its group query parameter.