Jump to: navigation, search
(Undo revision 329527 by Jumunn (talk))
Line 7: Line 7:
 
Recording will stop when the call is completed or [[CallRecordingStopCallRecording|StopCallRecording]] is called either on the call or on the device.
 
Recording will stop when the call is completed or [[CallRecordingStopCallRecording|StopCallRecording]] is called either on the call or on the device.
  
−
== Example==
+
{|
−
===Request:===
+
! Request URL
−
<pre>
+
| /api/v2/me/calls/{id}
−
POST /api/v2/me/calls/00RV9H7S6O8V3BSHAG7GK2LAES00002M
+
|-
 +
! HTTP Method
 +
| POST
 +
|-
 +
! Required Features
 +
| api-voice-recording
 +
|}
 +
 
 +
==Parameters==
 +
{|
 +
! Parameter
 +
! Value
 +
|-
 +
| operationName
 +
| StartCallRecording
 +
|}
 +
 
 +
== Sample==
 +
===Request===
 +
<source lang="text">
 +
POST /api/v2/me/calls/01RCC3N118B1V0SL8O7GK2LAES00000V
 
{
 
{
 
   "operationName": "StartCallRecording"
 
   "operationName": "StartCallRecording"
 
}
 
}
−
</pre>
+
</source>
  
−
===Response:===
+
===Response===
−
<pre>
+
<source lang="text">
 
{
 
{
 
   "statusCode": 0
 
   "statusCode": 0
 
}
 
}
−
</pre>
+
</source>
−
 
 
−
=== Event: ===
 
  
−
<pre>
+
=== Notification ===
−
{
+
<source lang="text">
−
  "data": {
+
{
−
    "messageType": "CallStateChangeMessage",
+
  "data":{
−
    "extensions": {
+
      "notificationType":"CallRecordingStateChange",
−
      "WrapUpTime": 0,
+
       "call":{
−
       "BusinessCall": 0
+
        "id":"01RCC3N118B1V0SL8O7GK2LAES00000V",
−
    },
+
        "state":"Established",
−
    "call": {
+
        "callUuid":"01RCC3N118B1V0SL8O7GK2LAES00000V",
−
      "id": "00RV9H7S6O8V3BSHAG7GK2LAES00002M",
+
        "connId":"007102719818001f",
−
      "connId": "0071022ec8ac8056",
+
        "deviceUri":"http://127.0.0.1:8080/api/v2/devices/631608b3-ceb1-472b-ba05-2ae39555b0d1",
−
      "state": "Established",
+
        "participants":[
−
      "callUuid": "00RV9H7S6O8V3BSHAG7GK2LAES00002M",
+
            {
−
      "deviceUri": "http://127.0.0.1:8080/api/v2/devices/55b8023d-573d-48d3-b4ac-e29ba3c5861d",
+
              "e164Number":"",
−
      "uri": "http://127.0.0.1:8080/api/v2/me/calls/00RV9H7S6O8V3BSHAG7GK2LAES00002M",
+
              "formattedPhoneNumber":"15001",
−
      "participants": [
+
              "phoneNumber":"15001",
−
        "5000"
+
              "digits":"15001"
−
      ],
+
            }
−
      "participantsInfo": [
+
        ],
−
        {
+
        "dnis":"15001",
−
          "country": {
+
        "callType":"Internal",
−
            "name": "",
+
        "capabilities":[
−
            "code": "",
+
            "UpdateUserData",
−
            "callingCode": ""
+
            "SendDtmf",
−
          },
+
            "InitiateConference",
−
          "formattedPhoneNumber": "5000",
+
            "Hold",
−
          "location": null,
+
            "SingleStepTransfer",
−
          "E164digits": "5000",
+
            "InitiateTransfer",
−
          "isValidNumber": false
+
            "AttachUserData",
−
        }
+
            "DeleteUserDataPair",
−
      ],
+
            "SingleStepConference",
−
      "ani": "5000",
+
            "DeleteUserData",
−
      "dnis": "5001",
+
            "Hangup",
−
      "callType": "Internal",
+
            "PauseCallRecording",
−
      "capabilities": [
+
            "StopCallRecording"
−
        "DeleteUserDataPair",
+
        ],
−
        "SingleStepTransfer",
+
        "userData":{
−
        "InitiateConference",
+
            "GSIP_RECORD":"ON",
−
        "InitiateTransfer",
+
            "IW_BundleUid":"717f9130-a1d9-4092-f8b9-7804ee2592ea",
−
        "UpdateUserData",
+
            "IW_CaseUid":"d7e2c775-edaa-4d1e-b65c-bd48371b43ad",
−
        "Hold",
+
            "GSIP_REC_FN":"01RCC3N118B1V0SL8O7GK2LAES00000V_15000_15000_15001_2015-10-16_14-26-23_hpe-voicevm-70-dot-genesyslab-dot-com__%3Ccont_center_id%3E"
−
        "Hangup",
+
        },
−
        "DeleteUserData",
+
        "duration":"34",
−
        "SingleStepConference",
+
        "mute":"Off",
−
        "SendDtmf",
+
        "recordingState":"Recording",
−
        "AttachUserData",
+
        "supervisorListeningIn":false,
−
        "PauseCallRecording",
+
        "monitoredUserMuted":false,
−
        "StopCallRecording"
+
        "monitoring":false,
−
      ],
+
        "uri":"http://127.0.0.1:8080/api/v2/me/calls/01RCC3N118B1V0SL8O7GK2LAES00000V",
−
      "userData": {
+
        "path":"/calls/01RCC3N118B1V0SL8O7GK2LAES00000V"
−
        "GSIP_RECORD": "ON",
 
−
        "IW_CaseUid": "8dfca5ac-ed84-4f9a-d902-8ef3c2faad81",
 
−
        "IW_BundleUid": "ba431089-f52b-4ce2-0658-f8bdfdfe3034",
 
−
        "GSIP_REC_FN": "00RV9H7S6O8V3BSHAG7GK2LAES00002M_5001_5000_5001_2013-08-09_21-11-22_hpe-voicevm-84.genesyslab.com__%3Ccont_center_id%3E"
 
 
       },
 
       },
−
       "duration": "106",
+
       "phoneNumber":"15000",
−
       "mute": "Off",
+
       "messageType":"CallStateChangeMessage"
−
      "recordingState": "Recording"
+
  },
−
    },
+
  "channel":"/v2/me/calls"
−
    "phoneNumber": "5001",
 
−
    "notificationType": "CallRecordingStateChange"
 
−
  },
 
−
  "channel": "/v2/me/calls"
 
 
}
 
}
−
</pre>
+
</source>
  
 
[[Category:V:HTCC:8.5.2]]
 
[[Category:V:HTCC:8.5.2]]

Revision as of 23:26, December 20, 2015

StartCallRecording

This operation is part of the Voice API section of the Genesys Web Services REST 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"
}

Response

{
  "statusCode": 0
}

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!