JSON API » callergroups » callergroups/callers/update

Updates a caller in a caller group.

Input parameters

Requires authentication and the system role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
callergroupIntegerID of caller group.Yes
caller_prefixStringCaller prefix.Yes
called_minIntegerMinimum length of called number to match.Yes1
called_maxIntegerMaximum length of called number to match.Yes100
descriptionStringDescription.Yes
idIntegerID of a caller in a caller group.Yes

Responses

CodeDescription
204Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.
404The caller group or caller 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/callergroups/callers/update/?auth_username=user;auth_password=password;callergroup=123;caller_prefix=1234567;called_min=1;called_max=100;description=description;id=234

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

Change history

VersionChanges
4.2Function added.