Articles in this support section discuss Telebroad's legacy APIs. To learn about the current version of Telebroad APIs, which offer additional authentication options and support for advanced features, please go to https://developers.telebroad.com/.
With the PUT/speeddial request, you can create a new speed dial or Busy Lamp Field (BLF) button or update existing buttons of a physical phone that is associated with your TeleConsole account. For the new or updated button to work on the phone, it must be rebooted. We have reboot instructions for most phones we support. See the respective phone user manuals.
Parameters
All parameters go in the request body in JSON Raw format.
| Parameter | Type | Operation |
| 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. |
| stype | string | (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 | integer | The 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 | string | The destination number dialled with the the speed dial or BLF button. |
| dname | string | The name of the destination recipient receiving the call dialled with the speed dial or BLF button. |
| button | string | Omit or leave blank to designate 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 contains 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 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 a successful update.
{
"error": null,
"result": "true"
}