Use this request to park a phone call. This action results in a party of the phone call being parked in the system's parking lot.
The Service identifies the phone call using the User Id, the Extension number and PhoneCall Id.
If successful, the Service returns thethat was updated.
The request is made by an App that is registered to a User account.
To park a phone call, 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 parking PhoneCalls, the following restrictions apply to the PhoneCall resource sent in the Request Payload.
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_parktimeout_invalid||Value supplied in maxInParking parameter is missing or invalid. The parameter must be set to a numeric value and represents the number of seconds a call can stay in the parking lot.|
|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 parks the phone call between local number 0003*210 and public number 3235742879. It will send the phone number 3235742879 to the parking lot. The phoneCallViewId is set to 01, identifying the view of 3235742879.
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:
Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 4.0 International.