JSON API » patternmenus » patternmenus/patterns/create

Creates a new pattern.

Input parameters

Requires authentication and the user role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
patternmenu	Integer	ID of pattern menu.	Yes
dtype	String	Destination type.	Yes
dnumber	String	Destination number.	Yes
cnumber	String	The called number to match. Empty string for any.	No	Empty string.
description	String	Description.	No	Empty string.
digits	String	Digits entered by caller to match. Empty string for any.	No	Empty string.
priority	Integer	Priority from 1 to 10.	No	1
snumber	String	Calling number to match. Empty string for any.	No	Empty string.
type	String	Type of match. "contains", "exact", or "regular_expression".	No	"exact"
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 pattern menu does not exist, or you do not have permission to view it.

Data returned

The ID of the created pattern.

Example: With callerid

http://enswitch.example.com/api/json/patternmenus/patterns/create/?auth_username=user;auth_password=password;patternmenu=123;dtype=phone;dnumber=1234567;snumber=2125551234

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

Change history

Version	Changes
3.13	Function added.