JSON API » numbers » numbers/callerids/get
Gets the fields of a number callerid group route.
Input parameters
Requires authentication and the administrator, user, or wholesale role privileges.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes | |
number | String | Number. | Yes | |
calleridgroup | Integer | ID of callerid group. | Yes |
Responses
Code | Description |
---|---|
200 | Success. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
404 | The number or callerid route does not exist, or you do not have permission to view it. |
Data returned
Fields of number callerid route.
Example: With required parameters
http://enswitch.example.com/api/json/numbers/callerids/get/?auth_username=user;auth_password=password;number=2125551234;calleridgroup=123{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "number":"2125551234", "calleridgroup":1, ... } }
Change history
Version | Changes |
---|---|
4.3 | Function added. |