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/.
The PUT/phone/forwarding request enables (or disables) call forwarding of a user's phone line to a specific phone number.
Parameters
All parameters go in the request body in JSON Raw format.
| Parameter | Type | Operation |
| number | string | The phone number calls are to be forwarded to. To deactivate forwarding, leave the field empty! |
| phone | string | Optional. Use this parameter to specify the phone line the forwarding will apply to if the user's account has more than one line. |
Examples
Enabling Forwarding
To enable forwarding of all calls from phone line 124380 to destination number 1-347-535-2211, use this syntax:
HTTP method: PUT
Header
webserv.telebroad.com/api/teleconsole/rest/phone/forwarding
Body
{"number":"13475352211", "phone":"124380"}
Response:
If forwarding was enabled successfully:
{
"error": null,
"result": true
}
If forwarding was not succesful because the wrong phone line was specified:
{
{ "code": 444,
"message": "Phone line does not exist" }
}
Disabling Forwarding
To disable forwarding of all calls from phone line 124380 use this syntax:
HTTPS method: PUT
Header
webserv.telebroad.com/api/teleconsole/rest/phone/forwarding
Body
For a specific line on an account with more than one line:
{"number":"", "phone":"124380"}
If the account has only one line:
{"number":""}
Response:
If forwarding was disabled successfully:
{
"error": null,
"result": true
}