JSON API » speeddials » speeddials/create

Creates a new speed dial.

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
stype	String	Source type. "phone", or empty string for shared.	Yes
snumber	String	Source number. Telephone line, or empty string for shared.	Yes
sdial	String	Number to dial.	Yes
dnumber	String	Destination number.	Yes
button	String	Button type. Empty string for none.	No	Empty string.
customer	Integer	ID of customer to create in.	No	Customer of authentication user.
description	String	Description.	No	Empty string.
dname	String	Destination name..	No	Empty string.
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 speed dial.

Example: Telephone line speed dial

http://enswitch.example.com/api/json/speeddials/create/?auth_username=user;auth_password=password;stype=phone;snumber=1234567;sdial=1;dnumber=2125551234

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

Example: Shared speed dial

http://enswitch.example.com/api/json/speeddials/create/?auth_username=user;auth_password=password;stype=;snumber=;sdial=1;dnumber=2125551234

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

Change history

Version	Changes
3.13	Function added.