JSON API » calleridgroups » calleridgroups/callers/create

Adds a caller to a callerid group. If the caller is already in the callerid 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
calleridgroup	Integer	ID of callerid group.	Yes
caller_prefix	String	Caller prefix.	Yes
called_min	Integer	Minimum length of called number to match.	Yes	1
called_max	Integer	Maximum length of called number to match.	Yes	100
description	String	Description.	Yes
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Code	Description
204	Success.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The callerid 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/calleridgroups/callers/create/?auth_username=user;auth_password=password;calleridgroup=123;caller_prefix=1234567;called_min=1;called_max=100;description=description

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

Change history

Version	Changes
4.3	Function added.