PUT/Speeddial (use also for BLF)

With the PUT/speeddial request you can create a new or update an existing speed dial or Busy Lamp Field (BLF) button for any physical phone that is associated with your TeleConsole account. For the the new or updated button to work on the phone it must be rebooted. We have rebooting instructions for the majority of phones we support. See respective phones user manuals.


Parameters


There are no parameters in the header. All parameters go in the body in JSON Raw format.


ParameterTypeOperation
id
integer
Use a blank or 0 value to create a new button.

Use an existing ID (obtained from the GET/speedials request) to update an existing button.
description
string(optional) Self explanatory - a description of what the button does or whom does it dials.
stypestring

(optional) The source type. It should always be "phone" for a specific line or blank value for shared speed dials. 

snumber
string(optional) Source number. Specify the telephone number the speed dial will apply for or leave a blank value for shared speed dials.
sdial
integerThe number of the speed dial button.  Use the GET/speedials request to see which button is available.
dtype
string(optional) Destination type. Normally empty string.
dnumber
stringThe destination number dialled with the the speed dial or BLF button.
dname
stringThe name of the destination recipient receiving the call dialled with the speed dial or BLF button.
button
stringOmit or leave blank for designating the button as a speed dial (the default choice). Use "blf" to designate the button as a BLF. 

Examples


Creating a New Button


To create a new speed dial number on button 2 that will call 1-646-555-4445 use the following syntax:


HTTPS method: PUT


Header


webserv.telebroad.com/api/teleconsole/rest/speedial


Body


{"sdial":"2",  "description":"My main contact with the MVI supplies", "id": "", "dnumber":"16465554445", "dname":"Claire Anderson"}


Response:


The response contain the ID of the new button -


{

    "error": null, {  

        "result": { "id": "47858" } }

}


But if you try to create a new button over an existing one you get an error message - 


{

    "error": {

        "code": 444,

        "message": "Bad request"

    }

}


Updating an Existing Button


To update an existing a new speed dial number with ID 47858  use the following syntax:


Body


{"sdial":"2",  "description":"My main contact with the MVI supplies", "id": "47858", "dnumber":"16465554472", "dname":"Claire Anderson's new number"}


Response:


A "null" error indicates successful update. 


{

    "error": null,

    "result": "true"

}

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.