(Update with the copy of version: 8.5.2DRAFT) |
(Update with the copy of version: 8.5.2DRAFT) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 3: | Line 3: | ||
This operation is part of the [[VoiceAPI|Voice API]] section of the [[Welcome|Web Services API]]. | This operation is part of the [[VoiceAPI|Voice API]] section of the [[Welcome|Web Services API]]. | ||
==Overview== | ==Overview== | ||
| − | Starts call recording. | + | Starts call recording. Recording stops when the call is completed or you use the [[CallRecordingStopCallRecording|StopCallRecording]] operation on either the call or the device. |
| − | |||
| − | {| | + | {| class="wikitable" |
| − | |||
| − | |||
|- | |- | ||
| − | ! | + | !|Request URL |
| − | | | + | ||/api/v2/me/calls/''{id}'' |
|- | |- | ||
| − | ! Required | + | !|HTTP method |
| − | | api-voice-recording | + | ||POST |
| + | |- | ||
| + | !|Mandatory Header | ||
| + | ||Authorization: Basic xxxxx=Origin: server-url | ||
| + | |- | ||
| + | !|Required features | ||
| + | ||api-voice-recording | ||
|} | |} | ||
| + | |||
==Parameters== | ==Parameters== | ||
| − | {| | + | |
| − | + | {| class="wikitable" | |
| − | |||
|- | |- | ||
| − | | operationName | + | !|Parameter |
| − | | StartCallRecording | + | !|Value |
| + | |- | ||
| + | ||operationName | ||
| + | ||StartCallRecording | ||
|} | |} | ||
| − | == Sample== | + | |
| + | ==Sample== | ||
===Request=== | ===Request=== | ||
<source lang="text"> | <source lang="text"> | ||
| Line 36: | Line 43: | ||
</source> | </source> | ||
| − | === | + | ===HTTP response=== |
<source lang="text"> | <source lang="text"> | ||
{ | { | ||
| Line 43: | Line 50: | ||
</source> | </source> | ||
| − | === | + | ===CometD notification=== |
<source lang="text"> | <source lang="text"> | ||
{ | { | ||
Latest revision as of 11:16, April 1, 2019
StartCallRecording
This operation is part of the Voice API section of the Web Services API.
Overview
Starts call recording. Recording stops when the call is completed or you use the StopCallRecording operation on either the call or the device.
| Request URL | /api/v2/me/calls/{id} |
|---|---|
| HTTP method | POST |
| Mandatory Header | Authorization: Basic xxxxx=Origin: server-url |
| Required features | api-voice-recording |
Parameters
| Parameter | Value |
|---|---|
| operationName | StartCallRecording |
Sample
Request
POST /api/v2/me/calls/01RCC3N118B1V0SL8O7GK2LAES00000V
{
"operationName": "StartCallRecording"
}HTTP response
{
"statusCode": 0
}CometD notification
{
"data":{
"notificationType":"CallRecordingStateChange",
"call":{
"id":"01RCC3N118B1V0SL8O7GK2LAES00000V",
"state":"Established",
"callUuid":"01RCC3N118B1V0SL8O7GK2LAES00000V",
"connId":"007102719818001f",
"deviceUri":"http://127.0.0.1:8080/api/v2/devices/631608b3-ceb1-472b-ba05-2ae39555b0d1",
"participants":[
{
"e164Number":"",
"formattedPhoneNumber":"15001",
"phoneNumber":"15001",
"digits":"15001"
}
],
"dnis":"15001",
"callType":"Internal",
"capabilities":[
"UpdateUserData",
"SendDtmf",
"InitiateConference",
"Hold",
"SingleStepTransfer",
"InitiateTransfer",
"AttachUserData",
"DeleteUserDataPair",
"SingleStepConference",
"DeleteUserData",
"Hangup",
"PauseCallRecording",
"StopCallRecording"
],
"userData":{
"GSIP_RECORD":"ON",
"IW_BundleUid":"717f9130-a1d9-4092-f8b9-7804ee2592ea",
"IW_CaseUid":"d7e2c775-edaa-4d1e-b65c-bd48371b43ad",
"GSIP_REC_FN":"01RCC3N118B1V0SL8O7GK2LAES00000V_15000_15000_15001_2015-10-16_14-26-23_hpe-voicevm-70-dot-genesyslab-dot-com__%3Ccont_center_id%3E"
},
"duration":"34",
"mute":"Off",
"recordingState":"Recording",
"supervisorListeningIn":false,
"monitoredUserMuted":false,
"monitoring":false,
"uri":"http://127.0.0.1:8080/api/v2/me/calls/01RCC3N118B1V0SL8O7GK2LAES00000V",
"path":"/calls/01RCC3N118B1V0SL8O7GK2LAES00000V"
},
"phoneNumber":"15000",
"messageType":"CallStateChangeMessage"
},
"channel":"/v2/me/calls"
} This page was last edited on April 1, 2019, at 11:16.
Comments or questions about this documentation? Contact us for support!