api:pbx:extension:redirect
Table of Contents
API : PBX : Extension Redirect
Introduction
Set or clear redirect on an extension. When the extension is redirected all calls to it are forwarded to the specified number.
Request
| URL | https://api.telecomx.dk/pbx/extension/EXTENSION_ID/redirect | |
|---|---|---|
| Method | GET | |
| Access level | PERSONAL, VIEWER if extension belongs to the user or user has group permission setPresence on the extension. MANAGER or OWNER if user belongs to the customer. RESELLER if customer belongs to the reseller. ADMIN. |
|
| Param | EXTENSION_ID | Id of the extension (24 hex-char string) |
| Query | enable | True to enable redirection, false to disable. |
| number | Phone number to redirect to, local extension number or public E.164 formatted number. Only used if enabling. | |
Query examples
https://api.telecomx.dk/pbx/extension/1234567890ABCDEF12345678/redirect?enable=true&number=+4550802900 https://api.telecomx.dk/pbx/extension/1234567890ABCDEF12345678/redirect?enable=false
Response
| JSON object | ||
|---|---|---|
| state | Boolean | True if redirect has been enabled, false if it has been disabled. |
| number | String | Phone number to redirect to, not used if disabled. |
Example
{ "state": true, "number": "+4550802900" }
Errors
| Error code | Message | Description |
|---|---|---|
| 404 | not_found | Extension not found |
| 422 | number | Phone number is not valid |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/pbx/extension/redirect.txt · Last modified: 2021/04/28 11:29 by Per Møller