Prepare a Call Forwarding Through the PBX
This requests prepares a call through the PBX. The call is processed as follows:
-
the client app use this request to specify the phone number to call.
-
the server returns a phone number the client should dial to proceed.
-
the client dials the returned phone number.
-
the PBX answers the client’s call and bridges the call to the originally requested phone number.
The app must register the phone before making a call (see Device Registration).
The Call-Through capabilty must be configured (see Capabilities).
Resource
POST /me/device/forward_call
Parameters
None
Payload
The phone number the client intends to call.
Response
containing the phone number the client should dial in order to call through the PBX.
Context
| Authorization |
User |
| Device Registration |
Device with a phone number |
| Capabilities |
Call-Through |
Errors
| HTTP code | Xelion code | Description |
|---|---|---|
400 |
10200 |
no phone number is specified. |
10202 |
failed to decode the phone number. |
|
10050 |
No device is registered with the session. |
|
10052 |
No phone number is registered with the device. |
Example
POST https://xelion.nl/api/v1/master/me/device/forward_call
"0650005000"{
"value": "+31152511411",
}