Excerpt |
---|
This method allows retrieving a phone call from the parking lot. |
Table of Contents maxLevel 3 exclude Apps Using This, Quick Examples, Need Help?
Request/Response model
Overview
Use this request to retrieve a phone call from the parking lot.
The Service identifies the phone call using the User Id, Extension number, and PhoneCall Id. If successful, the Service returns the PhoneCall that was updated.
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:
Panel | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
HTTP-Method = "PUT" URI-Fragment = "/uapi/phoneCalls/" User-Id "/" Extension-Number "/" PhoneCall-Id Query-Parameters = null Request-Payload = PhoneCallAction Return-Object = PhoneCall |
Panel | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
PUT /uapi/phoneCalls/12/0003*210/b817d2618fe6f1804333
HTTP/1.1
HOST } |
Request
This section describes how to format the request to the service.
URI fragment
Anchor | ||||
---|---|---|---|---|
|
The following parameters must be sent in the URI fragment:
Name | Type | Required | Description |
---|---|---|---|
userId | Yes | Id of the User that owns the Extension involved in the call. | |
extension | Yes | The number of the Extension involved in the call. | |
phoneCallId | Yes | Id of a PhoneCall resource that must be updated. |
Request Payload
Anchor | ||||
---|---|---|---|---|
|
When unparking PhoneCalls, the following restrictions apply to the PhoneCall resource sent in the Request Payload.
Name | Type | Required | Description |
---|---|---|---|
action | String | Yes | Action must be set to UnPark. |
sendCallTo | UAPI-Extension-Number | Yes | 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. Default: the caller Id of the Phone Terminal Extension. |
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 PhoneCallView that is subject to the update. |
Response
Success
If successful, the Service returns the PhoneCall that was updated and the following HTTP statuses:
HTTP Code | Description |
---|---|
200 | The phone call is returned. |
204 | There is no phone call to be returned. |
Failure
When it fails, the request returns the following error codes:
HTTP Code | Code | Description |
---|---|---|
400 | pc_timeout_invalid | Value supplied in waitForPickup parameter is missing or invalid. The parameter must be numeric and higher than 0. |
400 | pc_callerid_invalid | Value supplied in callerId parameter is missing or invalid. The parameter must be set to a value with the format: John Doe <+3334444>. |
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. |
Response Body
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.
Example
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.
Anchor | ||||
---|---|---|---|---|
|
Code Block | ||
---|---|---|
| ||
PUT /uapi/phoneCalls/12/0003*210/b817d2618fe6f1804333 HTTP/1.1 HOST uapi.voipnow.com Content Type: application/json Authorization: Bearer token { "action": "UnPark", "sendCallTo": "0003*024", "callerId": "John Doe <42420042>", "waitForPickup": "20", "phoneCallViewId": "01" } |
Assuming that the request has been successful, the Service sends the following answer:
Code Block | ||
---|---|---|
| ||
HTTP/1.1 202 Accepted ... {"id":"b817d2618fe6f1804333", "extension":"0003*210", "link":{"self":"https://x.x.x.x//uapi/phoneCalls/12/0003*210/b817d2618fe6f1804333"} } |
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:
Code Block | ||
---|---|---|
| ||
HTTP/1.1 200 OK ... {"id":"b817d2618fe6f1804333", "extension":"0003*210", "ownerId":"3", "ownerName":"Default Organization", "answered":"2012-06-27T16:08:55+03:00", "published":"2012-06-27T16:08:50+02:00", "phoneCallView":[ { "id":"01", "extension":"0003*024", "answered":"2012-06-27T16:08:55+03:00", "status":"5", "callerId":"John Doe <3334444>", "source":["0003*024"], "destination":["0003*210"] } ] } |
Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 4.0 International.