API : PBX : Phonebook group create

API : PBX : Phonebook group create

Introduction

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) or writePhonebook (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.

This request creates a new, empty group. Put contacts in it through their groups property.

Request

URL	https://api.telecomx.dk/pbx/phonebookgroup
Method	POST
Access level	Customer group: MANAGER or OWNER if user belongs to the customer, RESELLER if customer belongs to the reseller, ADMIN. Personal group: PERSONAL and up for the user self, or with the group right `writePhonebook` on the employee.
Body	customer	`[optional]` Customer to create the group for. Defaults to the users own customer.
	personal	`[optional]` True to create a personal group, false (default) to create a customer group.
	employee	`[optional]` Employee owning the personal group. Defaults to the user self. Setting it implies personal.
	name	Name of the group, 1-50 characters. Must be unique (not case sensitive) among the customer groups, or among the employees personal groups.
	notes	`[optional]` Notes about what the group is used for, max 1000 characters.

Body examples

{
  name: 'VIP',
  notes: 'Customers who go straight to the account team'
}

{
  personal: true,
  name: 'Family'
}

Response

The created group, in the same format as Get.

Errors

Error code	Message	Description
403	access_denied	Insufficient access level
404	customer	Customer not found
404	employee	Employee not found
409	name	A phonebook group with that name already exists
422	name	Name is missing or longer than 50 characters
500	internal_error	<Unspecified>