Use this request to pick up a phone call that is received by another phone terminal.
The request identifies the phone call using the User Id, Extension number and PhoneCall Id. If successful, it returns the that was updated.
The request is made by an App that is registered to a User account.
To pick up phone calls in a desired context, issue a HTTP PUT request:
This section describes how to format the request to the service.
The following parameters must be sent in the URI fragment:
Id of the User that owns the Extension involved in the call.
Number of the Extension involved in the call.
Id of a PhoneCall resource that must be updated.
When picking up PhoneCalls, the following restrictions apply to the PhoneCall resource sent in the Request Payload:
|action||String||Yes||Action must be set to PickUp.|
|sendCallTo||UAPI-Extension-Number||Yes||Number of the Extension that connects to the parked phone call.|
Must refer to a
|callerId||UAPI-Caller-Id||No||The caller name and number. |
It is displayed to the source.
|waitForPickup||Number||No||The maximum number of seconds to wait until one of the phone numbers used picks up. |
When the time value set here runs out, the call is cancelled.
Default: 25 seconds.
|phoneCallViewId||String||Yes||The that is subject to the update.|
If successful, the request returns a collection of PhoneCalls and the following HTTP statuses:
|200||The phone call is returned.|
|204||There is no phone call to be returned.|
When it fails, the request returns the following error codes:
|400||pc_timeout_invalid||Value supplied in |
|400||pc_callerid_invalid||Value supplied in |
|400||pc_phonecall_invalid||Value supplied in |
|400||pc_phonecallview_invalid||Value supplied in |
|400||pc_sendcallto_invalid||Value supplied in sendCallTo parameter is missing or invalid. The parameter must be set to the number of a phone terminal extension.|
If any 4xx or 5xx status codes is returned, the body contains the error response. When the request is successful and 200 OK is returned, the body contains a JSON representation.
Below you can find an example that will help you understand the request and the response.
This example picks up the phone call that is received by Extension 0003*210. The phone call is then sent to the Extension 0003*024. The caller Id displayed to 0003*024 is the one set in the request: John Doe <42420042>.
The phoneCallViewId is set to 01, identifying the call that occurs on 0003*210 at the moment.
The request is made by an App on behalf of a User.
Assuming that the request has been successful, the Service sends the following answer:
Use the link returned by the Service to list the details of the PhoneCall making a List PhoneCalls request. The list request outputs the following:
Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 4.0 International.