Jump to: navigation, search
(HTCC-29871 (info from GIR-18182))
 
(6 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
=StopCallRecording=
 
=StopCallRecording=
 
__NOTOC__
 
__NOTOC__
−
This operation is part of the [[VoiceAPI|Voice API]] section of the [[Welcome|Genesys Web Services REST API]].
+
This operation is part of the [[VoiceAPI|Voice API]] section of the [[Welcome|Web Services API]].
 
==Overview==
 
==Overview==
 
Stop recording the specified phone call.
 
Stop recording the specified phone call.
  
−
== Example ==
+
 
−
===Request:===
+
{| class="wikitable"
−
<pre>
+
|-
−
POST '''<nowiki>http://localhost:8080/api/v2/me/calls/0071022ec8ac8056</nowiki>'''
+
!|Request URL
 +
||/api/v2/me/calls/''{id}''
 +
|-
 +
!|HTTP method
 +
||POST
 +
|-
 +
!|Mandatory Header
 +
||Authorization: Basic xxxxx=Origin: server-url
 +
|-
 +
!|Required features
 +
||api-voice-recording
 +
|}
 +
 
 +
 
 +
==Parameters==
 +
 
 +
{| class="wikitable"
 +
|-
 +
!|Parameter
 +
!|Value
 +
|-
 +
||operationName
 +
||StopCallRecording
 +
|}
 +
 
 +
 
 +
==Sample==
 +
===Request===
 +
<source lang="text">
 +
POST /api/v2/me/calls/01RCC3N118B1V0SL8O7GK2LAES00000V
 
{
 
{
 
   "operationName": "StopCallRecording"
 
   "operationName": "StopCallRecording"
 
}
 
}
−
</pre>
+
</source>
−
===Response:===
+
 
−
<pre>
+
===HTTP response===
 +
<source lang="text">
 
{
 
{
 
   "statusCode": 0
 
   "statusCode": 0
 
}
 
}
−
</pre>
+
</source>
−
===Event:===
+
 
−
<pre>
+
===CometD 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",
+
            "StartCallRecording"
−
      "capabilities": [
+
        ],
−
        "DeleteUserDataPair",
+
        "userData":{
−
        "SingleStepTransfer",
+
            "GSIP_RECORD":"OFF",
−
        "InitiateConference",
+
            "IW_BundleUid":"717f9130-a1d9-4092-f8b9-7804ee2592ea",
−
        "InitiateTransfer",
+
            "IW_CaseUid":"d7e2c775-edaa-4d1e-b65c-bd48371b43ad",
−
        "UpdateUserData",
+
            "GSIP_REC_FN":"01RCC3N118B1V0SL8O7GK2LAES00000V_15000_15000_15001_2015-10-16_14-26-23_hpe-voicevm-70-dot-genesyslab-dot-com__%3Ccont_center_id%3E"
−
        "Hold",
+
        },
−
        "Hangup",
+
        "duration":"353",
−
        "DeleteUserData",
+
        "mute":"Off",
−
        "SingleStepConference",
+
        "recordingState":"Stopped",
−
        "SendDtmf",
+
        "supervisorListeningIn":false,
−
        "AttachUserData",
+
        "monitoredUserMuted":false,
−
        "StartCallRecording"
+
        "monitoring":false,
−
      ],
+
        "uri":"http://127.0.0.1:8080/api/v2/me/calls/01RCC3N118B1V0SL8O7GK2LAES00000V",
−
      "userData": {
+
        "path":"/calls/01RCC3N118B1V0SL8O7GK2LAES00000V"
−
        "GSIP_RECORD": "OFF",
 
−
        "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": "613",
+
       "phoneNumber":"15000",
−
       "mute": "Off",
+
       "messageType":"CallStateChangeMessage"
−
      "recordingState": "Stopped"
+
  },
−
    },
+
  "channel":"/v2/me/calls"
−
    "phoneNumber": "5001",
 
−
    "notificationType": "CallRecordingStateChange"
 
−
  },
 
−
  "channel": "/v2/me/calls"
 
 
}
 
}
−
</pre>
+
</source>
  
 
[[Category:V:HTCC:8.5.2DRAFT]]
 
[[Category:V:HTCC:8.5.2DRAFT]]

Latest revision as of 07:01, January 16, 2019

StopCallRecording

This operation is part of the Voice API section of the Web Services API.

Overview

Stop recording the specified phone call.


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 StopCallRecording


Sample

Request

POST /api/v2/me/calls/01RCC3N118B1V0SL8O7GK2LAES00000V
{
  "operationName": "StopCallRecording"
}

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",
            "StartCallRecording"
         ],
         "userData":{  
            "GSIP_RECORD":"OFF",
            "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":"353",
         "mute":"Off",
         "recordingState":"Stopped",
         "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 January 16, 2019, at 07:01.
Comments or questions about this documentation? Contact us for support!