JSON API » ingroups » ingroups/nvgroups/create
Creates a new number vendor group in an inbound group.
Input parameters
Requires authentication and the system role privilege.
| Name | Type | Description | Required | Default value |
|---|---|---|---|---|
| auth_username | String | Authentication username. | Yes | |
| auth_password | String | Authentication password. | Yes | |
| class | Integer | ID of number class to put numbers in. | Yes | |
| ingroup | Integer | ID of inbound group. | Yes | |
| nvgroup | String | Name of number vendor group. | Yes | |
| vendor | String | Name of vendor. | Yes | |
| priority | Integer | Priority from 1 to 10. | No | 1 |
| validation | Integer | 1 to validate input then return, 0 for full action. | No | 0 |
Responses
| Code | Description |
|---|---|
| 200 | Success. |
| 201 | Input passed validation. Only returned if validation=1. |
| 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. |
Data returned
The ID of the created number vendor group.
Example: With required parameters
http://enswitch.example.com/api/json/ingroups/nvgroups/create/?auth_username=user;auth_password=password;class=1;ingroup=2;nvgroup=example1;vendor=example2{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123 } }
Change history
| Version | Changes |
|---|---|
| 3.13 | Function added. |
