JSON API » speeddials » speeddials/unused/sdial

Gets next available unused speed dial number for a given source. This can be a telephone line, or shared speed dials in a given customer.

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
customer	Integer	ID of customer to get unused number for.	No	Customer of authentication user.
stype	String	Source type. "phone", or empty string for shared.	No	Empty string.
snumber	String	Source number, or empty string for shared.	No	Empty string.

Responses

Code	Description
200	Success.
400	Invalid customer specified.
401	The authentication details provided are invalid.
402	Your role does not allow this.

Data returned

The speed dial number, or empty string if none could be found.

Example: With required parameters

http://enswitch.example.com/api/json/speeddials/unused/sdial/?auth_username=user;auth_password=password

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "sdial":"123456" } }

Example: With customer, and no spare sdial number could be found in that customer

http://enswitch.example.com/api/json/speeddials/unused/sdial/?auth_username=user;auth_password=password;customer=123

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

Change history

Version	Changes
3.13	Function added.