JSON API » callshops » callshops/create

Creates new call shop sub-customers and telephone lines.

Input parameters

Requires authentication and the callshop telephones role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
credit	Decimal	Credit limit to give each customer.	Yes
number	Integer	Number of customers to create.	Yes
plan	Integer	ID of rate plan to put customers on.	Yes
customer	Integer	ID of customer to create under.	No	Customer of authentication user.
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.
403	Your rate plan does not allow this.
404	The customer does not exist, or you do not have permission to view it.

Data returned

Details of new customers and telephone lines.

Example: With required parameters

http://enswitch.example.com/api/json/callshops/create/?auth_username=user;auth_password=password;credit=100.00;number=2;plan=123

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "customer":123, "username":"1234567", ... }, { "customer":124, "username":"1234568", ... } ] }

Change history

Version	Changes
3.13	Function added.