Jump to: navigation, search
(Update with the copy of version: 8.5.2DRAFT)
Line 1: Line 1:
 
=StartCallRecording=
 
=StartCallRecording=
 
__NOTOC__
 
__NOTOC__
 +
This operation is part of the [[VoiceAPI|Voice API]] section of the [[Welcome|Genesys Web Services REST API]].
 +
==Overview==
 +
Starts call recording.
  
Starts call recording. 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==
 
== Example==
 
 
===Request:===
 
===Request:===
 
POST '''<nowiki>http://localhost:8080/api/v2/me/calls/0071022ec8ac8056</nowiki>'''
 
POST '''<nowiki>http://localhost:8080/api/v2/me/calls/0071022ec8ac8056</nowiki>'''

Revision as of 16:29, June 20, 2014

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.

Example

Request:

POST http://localhost:8080/api/v2/me/calls/0071022ec8ac8056

{
  "operationName": "StartCallRecording"
}

Response:

{
  "statusCode": 0
}

Event:

{
  "data": {
    "messageType": "CallStateChangeMessage",
    "call": {
      "id": "0071022ec8ac8056",
      "state": "Established",
      "callUuid": "00RV9H7S6O8V3BSHAG7GK2LAES00002M",
      "deviceUri": "http://127.0.0.1:8080/api/v2/devices/55b8023d-573d-48d3-b4ac-e29ba3c5861d",
      "uri": "http://127.0.0.1:8080/api/v2/me/calls/0071022ec8ac8056",
      "participants": [
        "5000"
      ],
      "participantsInfo": [
        {
          "country": {
            "name": "",
            "code": "",
            "callingCode": ""
          },
          "formattedPhoneNumber": "5000",
          "location": null,
          "E164digits": "5000",
          "isValidNumber": false
        }
      ],
      "ani": "5000",
      "dnis": "5001",
      "callType": "Internal",
      "capabilities": [
        "DeleteUserDataPair",
        "SingleStepTransfer",
        "InitiateConference",
        "InitiateTransfer",
        "UpdateUserData",
        "Hold",
        "Hangup",
        "DeleteUserData",
        "SingleStepConference",
        "SendDtmf",
        "AttachUserData",
        "PauseCallRecording",
        "StopCallRecording"
      ],
      "userData": {
        "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",
      "mute": "Off",
      "recordingState": "Recording"
    },
    "phoneNumber": "5001",
    "notificationType": "CallRecordingStateChange"
  },
  "channel": "/v2/me/calls"
}
Comments or questions about this documentation? Contact us for support!