Jump to: navigation, search
(→‎Follow)
(Update with the copy of version: 8.5.2DRAFT)
Line 1: Line 1:
 
=Follow=
 
=Follow=
 
__NOTOC__
 
__NOTOC__
−
This operation will enable monitoring a specific Twitter user's tweets.
+
This operation is part of the [[Twitter|Twitter API]] section of the [[Welcome|Genesys Web Services REST API]].
 +
==Overview==
 +
Enables monitoring of a specific Twitter user's tweets.
 +
{|
 +
! Request URL
 +
| /api/v2/me/twitter
 +
|-
 +
! HTTP Method
 +
| POST
 +
|-
 +
! Required Features
 +
| api-multimedia
 +
|}
  
−
== HTTP Request ==
+
==Parameters==
−
POST on '''/twitter'''
+
{|
−
<pre>
+
! Parameter
 +
! Value
 +
|-
 +
| operationName
 +
| Follow
 +
|-
 +
| twitterUserId
 +
| A Twitter user's numeric unique identifier.
 +
|-
 +
| from
 +
| The Twitter account name on whose behalf the Follow operation is performed.
 +
|}
 +
 
 +
==Samples==
 +
===Request===
 +
<source lang="text">
 +
POST api/v2/me/twitter
 +
{
 +
  "operationName": "Follow",
 +
  "twitterUserId": "1234567890",
 +
  "from": "customer_support"
 +
}
 +
</source>
 +
===HTTP Response===
 +
<source lang="text">
 
{
 
{
−
   "operationName":"Follow",
+
   "statusCode": 0,
−
   "twitterUserId": a Twitter user's numeric unique identifier
+
   "referenceId": 1
 
}
 
}
−
</pre>
+
</source>
−
== HTTP Response ==
+
===CometD Response===
−
 
+
====Success====
−
===Success===
+
<source lang="text">
−
<pre>
 
 
{
 
{
−
   "statusCode": 0
+
   "messageType": "TwitterOperationResponse",
 +
  "referenceId": 1,
 +
  "success": "true"
 
}
 
}
−
</pre>
+
</source>
−
 
+
====Failure====
−
===Failure===
+
<source lang="text">
−
<pre>
 
 
{
 
{
−
   "statusCode": an integer value above 0,
+
   "messageType": "TwitterOperationResponse",
−
   "statusMessage":details
+
  "referenceId": 1,
 +
  "success": "false",
 +
   "errorMessage": "Unable to perform twitter operation"
 
}
 
}
−
</pre>
+
</source>
−
 
 
−
For details on the statusCode value, please refer to the All Methods sub-section of the Return Values section.
 
  
 
[[Category:V:HTCC:8.5.2]]
 
[[Category:V:HTCC:8.5.2]]

Revision as of 18:40, April 3, 2015

Follow

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

Overview

Enables monitoring of a specific Twitter user's tweets.

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

Parameters

Parameter Value
operationName Follow
twitterUserId A Twitter user's numeric unique identifier.
from The Twitter account name on whose behalf the Follow operation is performed.

Samples

Request

POST api/v2/me/twitter
{
  "operationName": "Follow",
  "twitterUserId": "1234567890",
  "from": "customer_support"
}

HTTP Response

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

CometD Response

Success

{
  "messageType": "TwitterOperationResponse",
  "referenceId": 1,
  "success": "true"
}

Failure

{
  "messageType": "TwitterOperationResponse",
  "referenceId": 1,
  "success": "false",
  "errorMessage": "Unable to perform twitter operation"
}
Comments or questions about this documentation? Contact us for support!