JSON API » prefixes » prefixes/create

Creates a new feature prefix.

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
prefix	String	Called number prefix.	Yes
dtype	String	Destination type.	Yes
dnumber	String	Destination number.	Depends on dtype.	Empty string.
called_minimum	Integer	Minimum length of called number to match.	No	1
called_maximum	Integer	Maximum length of called number to match.	No	100
customer	Integer	ID of customer to create in.	No	Customer of authentication user.
description	String	Description.	No	Empty string.
pin	String	PIN to use. Empty string for none.	No	Empty string.
shared	Integer	1 to share with all customers on system, 0 not to.	No	0
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Prefix	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.

Data returned

The ID of the created feature prefix.

Example: With required parameters

http://enswitch.example.com/api/json/prefixes/create/?auth_username=user;auth_password=password;prefix=100;dtype=hidecallerid

{ "responses":[ { "prefix":"200", "key":"", "message":"OK" } ], "data":{ "id":123 } }

Change history

Version	Changes
3.13	Function added.