JSON API » pickupgroups » pickupgroups/phones/add

Adds a telephone line to a pickup group. If the telephone line is already in the pickup group, does nothing.

Input parameters

Requires authentication and the administrator role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
pickupgroup	Integer	ID of pickup group.	Yes
phone	String	Telephone line to add.	Yes

Responses

Code	Description
204	Success.
400	The telephone line does not exist, or you do not have permission to view it.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The pickup group does not exist, or you do not have permission to view it.

Data returned

No data is returned.

Example: With required parameters

http://enswitch.example.com/api/json/pickupgroups/phones/add/?auth_username=user;auth_password=password;pickupgroup=123;phone=1234567

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
3.13	Function added.