Jump to: navigation, search
(Update with the copy of version: 8.5.2DRAFT)
Line 1: Line 1:
−
=*Cancel=
+
=Cancel=
 +
__NOTOC__
 +
This operation is part of the [[Twitter|Twitter API]] section of the [[Welcome|Genesys Web Services REST API]].
 +
==Overview==
 +
Cancels a Twitter interaction.
 +
{|
 +
! Request URL
 +
| /api/v2/me/twitter/{Id}
 +
|-
 +
! HTTP Method
 +
| POST
 +
|-
 +
! Required Features
 +
| api-multimedia
 +
|}
  
−
{{Editgrn_open}}Transclude{{Editgrn_close}}
+
==Parameters==
 +
{|
 +
! Parameter
 +
! Value
 +
|-
 +
| operationName
 +
| Cancel
 +
|}
 +
 
 +
==Samples==
 +
===Request===
 +
<source lang="text">
 +
POST /api/v2/me/twitter/01QQQG2MU214P05G
 +
{
 +
  "operationName": "Cancel"
 +
}
 +
</source>
 +
 
 +
===HTTP Response===
 +
<source lang="text">
 +
{
 +
"statusCode": 0,
 +
"referenceId": 12
 +
}
 +
</source>
 +
 
 +
===CometD Response===
 +
<source lang="text">
 +
{
 +
  "messageType":"TwitterStateChangeMessage",
 +
  "notificationType":"StatusChange",
 +
  "referenceId":12,
 +
  "twitter":{
 +
      "capabilities":[ 
 +
 
 +
      ],
 +
      "id":"01QQQG2MU214P05G",
 +
      "state":"Canceled",
 +
      "twitterType":"Outbound",
 +
      "uri":"http://192.168.83.25:8080/api/v2/twitters/01QQQG2MU214P05G"
 +
  }
 +
}
 +
</source>
  
 
[[Category:V:HTCC:8.5.2]]
 
[[Category:V:HTCC:8.5.2]]

Revision as of 18:40, April 3, 2015

Cancel

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

Overview

Cancels a Twitter interaction.

Request URL /api/v2/me/twitter/{Id}
HTTP Method POST
Required Features api-multimedia

Parameters

Parameter Value
operationName Cancel

Samples

Request

POST /api/v2/me/twitter/01QQQG2MU214P05G
{
  "operationName": "Cancel"
}

HTTP Response

{
 "statusCode": 0,
 "referenceId": 12
}

CometD Response

{  
   "messageType":"TwitterStateChangeMessage",
   "notificationType":"StatusChange",
   "referenceId":12,
   "twitter":{  
      "capabilities":[  

      ],
      "id":"01QQQG2MU214P05G",
      "state":"Canceled",
      "twitterType":"Outbound",
      "uri":"http://192.168.83.25:8080/api/v2/twitters/01QQQG2MU214P05G"
   }
}
Comments or questions about this documentation? Contact us for support!