Jump to: navigation, search
(Update with the copy of version: 8.5.2DRAFT)
(Undo revision 329529 by Jumunn (talk))
Line 5: Line 5:
 
Temporarily stops recording the specified phone call
 
Temporarily stops recording the specified phone call
  
−
{|
+
== Example ==
−
! Request URL
+
===Request:===
−
| /api/v2/me/calls/{id}
+
<pre>
−
|-
+
POST http://localhost:8080/api/v2/me/calls/00RV9H7S6O8V3BSHAG7GK2LAES00002M
−
! HTTP Method
 
−
| POST
 
−
|-
 
−
! Required Features
 
−
| api-voice-recording
 
−
|}
 
−
 
 
−
==Parameters==
 
−
{|
 
−
! Parameter
 
−
! Value
 
−
|-
 
−
| operationName
 
−
| PauseCallRecording
 
−
|}
 
−
 
 
−
== Sample==
 
−
===Request===
 
−
<source lang="text">
 
−
POST /api/v2/me/calls/01RCC3N118B1V0SL8O7GK2LAES00000V
 
 
{
 
{
 
   "operationName": "PauseCallRecording"
 
   "operationName": "PauseCallRecording"
 
}
 
}
−
</source>
+
</pre>
  
−
===Response===
+
===Response:===
−
<source lang="text">
+
<pre>
 
{
 
{
 
   "statusCode": 0
 
   "statusCode": 0
 
}
 
}
−
</source>
+
</pre>
−
 
+
===Event:===
−
===Notification===
+
<pre>
−
<source lang="text">
+
{
−
{
+
  "data": {
−
  "data":{
+
    "messageType": "CallStateChangeMessage",
−
       "notificationType":"CallRecordingStateChange",
+
    "extensions": {
−
      "call":{
+
       "WrapUpTime": 0,
−
        "id":"01RCC3N118B1V0SL8O7GK2LAES00000V",
+
      "BusinessCall": 0
−
        "state":"Established",
+
    },
−
        "callUuid":"01RCC3N118B1V0SL8O7GK2LAES00000V",
+
    "call": {
−
        "connId":"007102719818001f",
+
      "id": "00RV9H7S6O8V3BSHAG7GK2LAES00002M",
−
        "deviceUri":"http://127.0.0.1:8080/api/v2/devices/631608b3-ceb1-472b-ba05-2ae39555b0d1",
+
      "connId": "0071022ec8ac8056",
−
        "participants":[
+
      "state": "Established",
−
             { 
+
      "callUuid": "00RV9H7S6O8V3BSHAG7GK2LAES00002M",
−
              "e164Number":"",
+
      "deviceUri": "http://127.0.0.1:8080/api/v2/devices/55b8023d-573d-48d3-b4ac-e29ba3c5861d",
−
              "formattedPhoneNumber":"15001",
+
      "uri": "http://127.0.0.1:8080/api/v2/me/calls/00RV9H7S6O8V3BSHAG7GK2LAES00002M",
−
              "phoneNumber":"15001",
+
      "participants": [
−
              "digits":"15001"
+
        "5000"
−
            }
+
      ],
−
        ],
+
      "participantsInfo": [
−
        "dnis":"15001",
+
        {
−
        "callType":"Internal",
+
          "country": {
−
        "capabilities":[
+
             "name": "",
−
            "UpdateUserData",
+
            "code": "",
−
            "SendDtmf",
+
            "callingCode": ""
−
            "InitiateConference",
+
          },
−
            "Hold",
+
          "formattedPhoneNumber": "5000",
−
            "SingleStepTransfer",
+
          "location": null,
−
            "InitiateTransfer",
+
          "E164digits": "5000",
−
            "AttachUserData",
+
          "isValidNumber": false
−
            "DeleteUserDataPair",
+
        }
−
            "SingleStepConference",
+
      ],
−
            "DeleteUserData",
+
      "ani": "5000",
−
            "Hangup",
+
      "dnis": "5001",
−
            "ResumeCallRecording",
+
      "callType": "Internal",
−
            "StopCallRecording"
+
      "capabilities": [
−
        ],
+
        "DeleteUserDataPair",
−
        "userData":{
+
        "SingleStepTransfer",
−
            "GSIP_RECORD":"PAUSED",
+
        "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-33-31_hpe-voicevm-70-dot-genesyslab-dot-com__%3Ccont_center_id%3E"
+
        "Hold",
−
        },
+
        "Hangup",
−
        "duration":"498",
+
        "DeleteUserData",
−
        "mute":"Off",
+
        "SingleStepConference",
−
        "recordingState":"Paused",
+
        "SendDtmf",
−
        "supervisorListeningIn":false,
+
        "AttachUserData",
−
        "monitoredUserMuted":false,
+
        "ResumeCallRecording",
−
        "monitoring":false,
+
        "StopCallRecording"
−
        "uri":"http://127.0.0.1:8080/api/v2/me/calls/01RCC3N118B1V0SL8O7GK2LAES00000V",
+
      ],
−
        "path":"/calls/01RCC3N118B1V0SL8O7GK2LAES00000V"
+
      "userData": {
 +
        "GSIP_RECORD": "PAUSED",
 +
        "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"
 
       },
 
       },
−
       "phoneNumber":"15000",
+
       "duration": "141",
−
      "messageType":"CallStateChangeMessage"
+
      "mute": "Off",
−
  },
+
      "recordingState": "Paused"
−
  "channel":"/v2/me/calls"
+
    },
 +
    "phoneNumber": "5001",
 +
    "notificationType": "CallRecordingStateChange"
 +
  },
 +
  "channel": "/v2/me/calls"
 
}
 
}
−
</source>
+
</pre>
  
 
[[Category:V:HTCC:8.5.2]]
 
[[Category:V:HTCC:8.5.2]]

Revision as of 20:09, October 23, 2015

PauseCallRecording

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

Overview

Temporarily stops recording the specified phone call

Example

Request:

POST http://localhost:8080/api/v2/me/calls/00RV9H7S6O8V3BSHAG7GK2LAES00002M
{
  "operationName": "PauseCallRecording"
}

Response:

{
  "statusCode": 0
}

Event:

{
  "data": {
    "messageType": "CallStateChangeMessage",
    "extensions": {
      "WrapUpTime": 0,
      "BusinessCall": 0
    },
    "call": {
      "id": "00RV9H7S6O8V3BSHAG7GK2LAES00002M",
      "connId": "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/00RV9H7S6O8V3BSHAG7GK2LAES00002M",
      "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",
        "ResumeCallRecording",
        "StopCallRecording"
      ],
      "userData": {
        "GSIP_RECORD": "PAUSED",
        "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": "141",
      "mute": "Off",
      "recordingState": "Paused"
    },
    "phoneNumber": "5001",
    "notificationType": "CallRecordingStateChange"
  },
  "channel": "/v2/me/calls"
}
Comments or questions about this documentation? Contact us for support!