(Auto-creation of topic Documentation:HTCC:API:TwitterUnfollow:8.5.2DRAFT via TOC Documentation:HTCC:APITOC8.5.2DRAFT) |
|||
Line 1: | Line 1: | ||
− | = | + | =Unfollow= |
+ | __NOTOC__ | ||
+ | This operation is part of the [[Twitter|Twitter API]] section of the [[Welcome|Genesys Web Services REST API]]. | ||
+ | ==Overview== | ||
+ | Disables 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 | ||
+ | | Unfollow | ||
+ | |- | ||
+ | | twitterUserId | ||
+ | | a Twitter user's numeric unique identifier | ||
+ | |- | ||
+ | | from | ||
+ | | Twitter account name on whose behalf the Unfollow operation is performed. | ||
+ | |} | ||
+ | |||
+ | ==Samples== | ||
+ | ===Request=== | ||
+ | <source lang="text"> | ||
+ | POST api/v2/me/twitter | ||
+ | { | ||
+ | "operationName": "Unfollow", | ||
+ | "twitterUserId": "1234567890", | ||
+ | "from": "customer_support" | ||
+ | } | ||
+ | </source> | ||
+ | ===HTTP Response=== | ||
+ | <source lang="text"> | ||
+ | { | ||
+ | "statusCode": 0, | ||
+ | "referenceId": 1 | ||
+ | } | ||
+ | </source> | ||
+ | ===CometD Response=== | ||
+ | ====Success==== | ||
+ | <source lang="text"> | ||
+ | { | ||
+ | "messageType": "TwitterOperationResponse", | ||
+ | "referenceId": 1, | ||
+ | "success": "true" | ||
+ | } | ||
+ | </source> | ||
+ | ====Failure==== | ||
+ | <source lang="text"> | ||
+ | { | ||
+ | "messageType": "TwitterOperationResponse", | ||
+ | "referenceId": 1, | ||
+ | "success": "false", | ||
+ | "errorMessage": "Unable to perform twitter operation" | ||
+ | } | ||
+ | </source> | ||
[[Category:V:HTCC:8.5.2DRAFT]] | [[Category:V:HTCC:8.5.2DRAFT]] |
Revision as of 15:42, March 5, 2015
Unfollow
This operation is part of the Twitter API section of the Genesys Web Services REST API.
Overview
Disables 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 | Unfollow |
twitterUserId | a Twitter user's numeric unique identifier |
from | Twitter account name on whose behalf the Unfollow operation is performed. |
Samples
Request
POST api/v2/me/twitter
{
"operationName": "Unfollow",
"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!