The request is made by an App that is registered to a User account.
To retrieve a phone call from the parking lot, 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:
When unparking PhoneCalls, the following restrictions apply to the PhoneCall resource sent in the Request Payload.
|action||String||Yes||Action must be set to UnPark.|
Number of the Extension that connects to the parked phone call.
|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||Thethat is subject to the update.|
If successful, the Service returns the PhoneCall that was updated 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 phoneCallId from the URI-Fragment is invalid. The parameter must be set to an alpha-numeric value and reference an existing phone call.|
|400||pc_phonecallview_invalid||Value supplied in phoneCallViewId parameter is missing or invalid. The parameter must reference a view of the phone call identfied by the phoneCallId given in the URI-Fragment.|
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 retrieves the PhoneCall with Id b817d2618fe6f1804333 from the parking lot. The service connects the number 0003*210, the one located in the parking lot, with the number 0003*024.
The phoneCallView is set to 01 identifying the view of 0003*210. 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.