| Line 9: | Line 9: | ||
{| | {| | ||
! Request URL | ! Request URL | ||
| − | | /api/v2/me/calls/{id} | + | | /api/v2/me/calls/''{id}'' |
|- | |- | ||
| − | ! HTTP | + | ! HTTP method |
| POST | | POST | ||
|- | |- | ||
| − | ! Required | + | ! Required features |
| api-voice-recording | | api-voice-recording | ||
|} | |} | ||
| Line 27: | Line 27: | ||
|} | |} | ||
| − | == Sample== | + | ==Sample== |
===Request=== | ===Request=== | ||
<source lang="text"> | <source lang="text"> | ||
| Line 36: | Line 36: | ||
</source> | </source> | ||
| − | === | + | ===HTTP response=== |
<source lang="text"> | <source lang="text"> | ||
{ | { | ||
| Line 43: | Line 43: | ||
</source> | </source> | ||
| − | === | + | ===CometD notification=== |
<source lang="text"> | <source lang="text"> | ||
{ | { | ||
Revision as of 20:31, February 16, 2016
StartCallRecording
This operation is part of the Voice API section of the Web Services API.
Overview
Starts call recording.
Recording will stop when the call is completed or StopCallRecording is called either on the call or on the device.
| Request URL | /api/v2/me/calls/{id} |
|---|---|
| HTTP method | POST |
| 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"
}
Comments or questions about this documentation? Contact us for support!