Use this request to stop recording a phone call, but make sure you have enabled the Call recording function in the Phone Terminal Setup page. Also, you must set the Record triggered option to When * 1 is pressed.
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 stop recording 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 stopping recording on a PhoneCall, the following restrictions apply to the PhoneCall resource sent in the Request Payload.
|action||String||Yes||Action must be set to StopRecording.|
|phoneCallViewId||String||Yes||The PhoneCallView that is subject to the update.|
If successful, the request returns thethat was updated and the following HTTP statuses:
|200||The list of phone calls is returned.|
|204||There are no phone calls to be returned.|
When it fails, the request returns the following error codes:
|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 identified 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 stops recording the conversation between 0003*210 and 7778888. The phoneCallViewId is set to 01, identifying the view of 7778888. 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.