Jump to: navigation, search
(CometD Response)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
=Save=
 
=Save=
 
__NOTOC__
 
__NOTOC__
This operation is part of the [[Twitter|Twitter API]] section of the [[Welcome|Genesys Web Services REST API]].
+
This operation is part of the [[Twitter|Twitter API]] section of the [[Welcome|Web Services API]].
 
==Overview==
 
==Overview==
 
Saves a Twitter interaction.
 
Saves a Twitter interaction.
 
{|
 
{|
 
! Request URL
 
! Request URL
| /api/v2/me/twitter/{id}
+
| /api/v2/me/tweets/{id}
 
|-
 
|-
 
! HTTP Method
 
! HTTP Method
Line 24: Line 24:
 
|-
 
|-
 
| twitter
 
| twitter
| Specified data with Twitter parameters. (optional)
+
| Specified data with Twitter parameters. (mandatory)
 
|}
 
|}
 
===Twitter Parameters===
 
===Twitter Parameters===
Line 42: Line 42:
 
====Request====
 
====Request====
 
<source lang="text">
 
<source lang="text">
POST api/v2/me/twitter/01QQQG2MU214P066
+
POST api/v2/me/tweets/01QQQG2MU214P066
 
  {
 
  {
 
     "operationName": "Save"
 
     "operationName": "Save"
Line 50: Line 50:
 
<source lang="text">
 
<source lang="text">
 
{
 
{
   "statusCode": 0
+
   "statusCode": 0,
 +
  "referenceId":40,
 
}
 
}
 
</source>
 
</source>
 +
 
====CometD Response====
 
====CometD Response====
 
<source lang="text">
 
<source lang="text">
Line 74: Line 76:
 
       "state":"Composing",
 
       "state":"Composing",
 
       "twitterType":"Outbound",
 
       "twitterType":"Outbound",
       "uri":"http://192.168.83.25:8080/api/v2/twitters/01QQQG2MU214P066",
+
       "uri":"http://192.168.83.25:8080/api/v2/tweet/01QQQG2MU214P066",
 
       "userData":{   
 
       "userData":{   
 
         "UserData2":123456789
 
         "UserData2":123456789
Line 85: Line 87:
 
====Request====
 
====Request====
 
<source lang="text">
 
<source lang="text">
POST api/v2/me/twitter/01QQQG2MU214P069
+
POST api/v2/me/tweets/01QQQG2MU214P069
 
  {
 
  {
 
     "operationName": "Save",
 
     "operationName": "Save",
Line 103: Line 105:
 
====CometD Response====
 
====CometD Response====
 
<source lang="text">
 
<source lang="text">
{"messageType": "TwitterStateChangeMessage",
+
{
"notificationType": "TwitterSaved",
+
  "messageType":"TwitterStateChangeMessage",
"referenceId": 16,
+
  "notificationType":"TwitterSaved",
"twitter": {"capabilities": ["Cancel",
+
  "referenceId":16,
                                "Send",
+
  "twitter":{
                                "AddComment",
+
      "capabilities":[
                                "AttachUserData",
+
        "Cancel",
                                "UpdateUserData",
+
        "Send",
                                "DeleteUserData",
+
        "AddComment",
                                "SetDisposition",
+
        "AttachUserData",
                                "SetInFocus",
+
        "UpdateUserData",
                                "Transfer"],
+
        "DeleteUserData",
              "from": "vitaliy_onv",
+
        "SetDisposition",
              "id": "01QQQG2MU214P069",
+
        "SetInFocus",
              "message": "Hello saved twitter!",
+
        "Transfer"
              "state": "Composing",
+
      ],
              "subject": "Hello saved twitter!",
+
      "from":"vitaliy_onv",
              "twitterType": "Outbound",
+
      "id":"01QQQG2MU214P069",
              "uri": "http://192.168.83.25:8080/api/v2/twitters/01QQQG2MU214P069",
+
      "message":"Hello saved twitter!",
              "userData": {"FromAddress": "vitaliy_onv",
+
      "state":"Composing",
                            "UserData2": 123456789}}}
+
      "subject":"Hello saved twitter!",
 +
      "twitterType":"Outbound",
 +
      "uri":"http://192.168.83.25:8080/api/v2/tweet/01QQQG2MU214P069",
 +
      "userData":{
 +
        "FromAddress":"vitaliy_onv",
 +
        "UserData2":123456789
 +
      }
 +
  }
 +
}
 
</source>
 
</source>
  
 
[[Category:V:HTCC:8.5.2DRAFT]]
 
[[Category:V:HTCC:8.5.2DRAFT]]

Latest revision as of 07:04, June 23, 2020

Save

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

Overview

Saves a Twitter interaction.

Request URL /api/v2/me/tweets/{id}
HTTP Method POST
Required Features api-multimedia

Parameters

Parameter Value
operationName Save
twitter Specified data with Twitter parameters. (mandatory)

Twitter Parameters

Parameter Value
from A user name for a Twitter account.
message The actual message to send. The body should be plain text.

Samples

Request Without a Twitter Resource

Request

POST api/v2/me/tweets/01QQQG2MU214P066
 {
    "operationName": "Save"
 }

HTTP Response

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

CometD Response

{  
   "messageType":"TwitterStateChangeMessage",
   "notificationType":"TwitterSaved",
   "referenceId":40,
   "twitter":{  
      "capabilities":[  
         "Cancel",
         "Send",
         "AddComment",
         "AttachUserData",
         "UpdateUserData",
         "DeleteUserData",
         "SetDisposition",
         "SetInFocus",
         "Transfer"
      ],
      "id":"01QQQG2MU214P066",
      "state":"Composing",
      "twitterType":"Outbound",
      "uri":"http://192.168.83.25:8080/api/v2/tweet/01QQQG2MU214P066",
      "userData":{  
         "UserData2":123456789
      }
   }
}

Request With a Twitter Resource

Request

POST api/v2/me/tweets/01QQQG2MU214P069
 {
    "operationName": "Save",
    "twitter" : 
        {
         "from": "vitaliy_onv",
         "message": "Hello saved twitter!"
        }
 }

HTTP Response

{
  "statusCode": 0
}

CometD Response

{  
   "messageType":"TwitterStateChangeMessage",
   "notificationType":"TwitterSaved",
   "referenceId":16,
   "twitter":{  
      "capabilities":[  
         "Cancel",
         "Send",
         "AddComment",
         "AttachUserData",
         "UpdateUserData",
         "DeleteUserData",
         "SetDisposition",
         "SetInFocus",
         "Transfer"
      ],
      "from":"vitaliy_onv",
      "id":"01QQQG2MU214P069",
      "message":"Hello saved twitter!",
      "state":"Composing",
      "subject":"Hello saved twitter!",
      "twitterType":"Outbound",
      "uri":"http://192.168.83.25:8080/api/v2/tweet/01QQQG2MU214P069",
      "userData":{  
         "FromAddress":"vitaliy_onv",
         "UserData2":123456789
      }
   }
}
This page was last edited on June 23, 2020, at 07:04.
Comments or questions about this documentation? Contact us for support!