Jump to: navigation, search
(=Message for Composing a Twitter Interaction)
Line 3: Line 3:
 
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|Genesys Web Services REST API]].
 
==Overview==
 
==Overview==
Adds the specified data to the interaction's UserData.
+
An agent can mark a Twitter interaction as completed. If the '''queuePath''' parameter is specified, then the Twitter interaction is placed in the specified queue.
 +
 
 
{|
 
{|
 
! Request URL
 
! Request URL
Line 21: Line 22:
 
|-
 
|-
 
| operationName
 
| operationName
| AttachUserData
+
| Complete
 
|-
 
|-
| userData
+
| queuePath
| The key value data to attach.
+
| The URI of the queue where GWS should place this Twitter interaction. (optional)
 
|}
 
|}
  
Line 30: Line 31:
 
===Request===
 
===Request===
 
<source lang="text">
 
<source lang="text">
POST api/v2/me/twitter/01QQQG2MU214P05N
+
POST api/v2/me/twitter/01QQQG2MU214P05K
 
{
 
{
   "operationName": "AttachUserData",
+
   "operationName": "Complete",
   "userData": {
+
   "queuePath": "/contacts/60ebbb94-3cef-4b14-95f8-5c49dbeb355d"
      "UserData1":"DATA1",
 
      "UserData2":123456789 
 
  }
 
 
}
 
}
 
</source>
 
</source>
Line 46: Line 44:
 
</source>
 
</source>
 
===CometD Response===
 
===CometD Response===
====Message for Processing a Twitter Interaction====
 
<source lang="text">
 
{
 
  "twitter": {
 
      "userData": {
 
          "_twitterUserImageURL": "http: //abs.twimg.com/sticky/default_profile_images/default_profile_1_normal.png",
 
          "FirstName": "Oleg",
 
          "LastName": "Witcher",
 
          "RTargetObjectSelected": "SocialMediaAgentGroup",
 
          "RVQDBID": "",
 
          "_twitterUserStatusesCount": "2",
 
          "CBR-actual_volume": "",
 
          "RVQID": "",
 
          "_twitterMsgType": "Status",
 
          "Screen_Sentiment_ScreenRuleName": "",
 
          "_twitterMsgPlainText": "On12: 58: 911/5/2013,
 
          Pcreatedapostsayinghelloworld!.",
 
          "_umsRequestId": "14",
 
          "_umsChannel": "channel-twitter",
 
          "_twitterUserId": "2175525290",
 
          "_twitterIsRetweet": "false",
 
          "Screen_Actionability_CtgName": "",
 
          "desktop_expand": "1",
 
          "RTargetObjSelDBID": "117",
 
          "CBR-Interaction_cost": "",
 
          "_umsInboundIxnSubmittedBy": "Cloud_localhost",
 
          "Screen_Sentiment_CtgRelevancy": "",
 
          "Screen_Actionability_CtgRelevancy": "",
 
          "desktop_sentiment": "Neutral",
 
          "_twitterUserCreatedAt": "2013-11-05T06: 56: 43Z",
 
          "_umsMediaType": "twitter",
 
          "desktop_actionable": "1",
 
          "_twitterFromAddr": "vitaliy_onv",
 
          "RRequestedSkills": None,
 
          "CBR-contract_DBIDs": "",
 
          "ContactId": "0000Ka96XNNU4488",
 
          "RTargetAgentSelected": "a1",
 
          "_twitterUserName": "OlegWitcher",
 
          "Classify_Sentiment_CtgRelevancy": "",
 
          "CBR-IT-path_DBIDs": "",
 
          "Classify_Actionability_CtgRelevancy": "",
 
          "Classify_Actionability_CtgName": "",
 
          "Classify_Sentiment_CtgId": "",
 
          "RTargetRuleSelected": "",
 
          "_twitterFromUserId": "2175525290",
 
          "_umsMediaAccount": "2175525290",
 
          "PegAGSocialMediaAgentGroup": 1,
 
          "UserData2": 123456789,
 
          "RTargetPlaceSelected": "a1",
 
          "ContactCreated": "false",
 
          "UserData1": "DATA1",
 
          "ContactIdList": "0000Ka96XNNU4488",
 
          "RTenant": "Environment",
 
          "_twitterToAddr": "vitaliy_onv",
 
          "_umsFromAddr": "vitaliy_onv",
 
          "Classify_Sentiment_CtgName": "",
 
          "IxnAlreadyCreatedInUCS": "1",
 
          "RouterData70": "("t"="1383649092 0")",
 
          "_twitterUserScreenName": "vitaliy_onv",
 
          "_twitterUserFriendsCount": "0",
 
          "_twitterUserIsFriend": "false",
 
          "Screen_Actionability_ScreenRuleName": "",
 
          "_twitterSource": "<ahref="http://www.kaermorhen.ru"rel="nofollow">Witcher_APP</a>",
 
          "KloutId": "",
 
          "RRequestedSkillCombination": "",
 
          "_umsChannelInfo": {
 
              "_twitterUserId": "2175525290",
 
              "_twitterUserImageURL": "http: //abs.twimg.com/sticky/default_profile_images/default_profile_1_normal.png",
 
              "_twitterUserName": "OlegWitcher",
 
              "_twitterSourceNickName": "TwitterApplicationSmServer-1",
 
              "_twitterUserScreenName": "vitaliy_onv"
 
          },
 
          "_twitterMsgId": "58765591",
 
          "RStrategyName": "TwitterAgentDeliveryStrategy",
 
          "RStrategyDBID": "985",
 
          "_twitterIsFavorited": "false",
 
          "CustomerSegment": "default",
 
          "_twitterUserIsFollower": "false",
 
          "Classify_Actionability_CtgId": "",
 
          "ServiceType": "default",
 
          "_umsChatPossible": "false",
 
          "Screen_Sentiment_CtgName": "",
 
          "_twitterUserUtcOffset": "-1",
 
          "_twitterQueryName": "stream-user",
 
          "ServiceObjective": 0,
 
          "NumberOfContactsFound": "1",
 
          "_twitterUserLanguage": "r",
 
          "FromAddress": "vitaliy_onv(OlegWitcher)",
 
          "RTargetRequested": "SocialMediaAgentGroup",
 
          "RTargetAgentGroup": "SocialMediaAgentGroup",
 
          "ClassifiedAndScreened": "1",
 
          "_twitterRetweetCount": "0",
 
          "_umsMsgPlainText": "On12: 58: 911/5/2013,
 
          Pcreatedapostsayinghelloworld!.",
 
          "_twitterUserFollowersCount": "0",
 
          "RTargetTypeSelected": "2",
 
          "_twitterCreatedAt": "2013-11-05T10: 58: 12Z",
 
          "Subject": "On12: 58: 911/5/2013,
 
          Pcreatedapos..."
 
      },
 
      "from": "vitaliy_onv(OlegWitcher)",
 
      "receivedDate": "2015-03-0214: 23: 11.000+0200",
 
      "suggestedQueueUris": [
 
         
 
      ],
 
      "capabilities": [
 
          "Reply",
 
          "Transfer",
 
          "AddComment",
 
          "AttachUserData",
 
          "UpdateUserData",
 
          "DeleteUserData",
 
          "SetDisposition",
 
          "SetInFocus",
 
          "Complete"
 
      ],
 
      "uri": "http: //192.168.83.25: 8080/api/v2/twitters/01QQQG2MU214P05N",
 
      "state": "Processing",
 
      "contactId": "0000Ka96XNNU4488",
 
      "revelantResponseTemplateGroups": [
 
         
 
      ],
 
      "message": "On12: 58: 911/5/2013,
 
      Pcreatedapostsayinghelloworld!.",
 
      "id": "01QQQG2MU214P05N",
 
      "twitterType": "Inbound",
 
      "subject": "On12: 58: 911/5/2013,
 
      Pcreatedapos..."
 
  },
 
  "referenceId": 27,
 
  "notificationType": "PropertiesUpdated",
 
  "messageType": "TwitterStateChangeMessage"
 
}
 
</source>
 
====Message for Composing a Twitter Interaction====
 
 
<source lang="text">
 
<source lang="text">
  {
+
{"messageType": "TwitterStateChangeMessage",
  "twitter": {
+
  "notificationType": "StatusChange",
      "userData": {
+
"referenceId": 45,
          "UserData2": 123456789,
+
"twitter": {"capabilities": [],
          "UserData1": "DATA1"
+
              "contactId": "0000Ka96XNNU4488",
      },
+
              "from": "vitaliy_onv(Oleg Witcher)",
      "uri": "http: //192.168.83.25: 8080/api/v2/twitters/01QQQG2MU214P05M",
+
              "id": "01QQQG2MU214P05K",
      "capabilities": [
+
              "message": "On 12:58:9 11/5/2013, P created a post saying hello world!.",
          "Cancel",
+
              "receivedDate": "2015-03-02 12:26:14.000+0200",
          "Send",
+
              "revelantResponseTemplateGroups": [],
          "AddComment",
+
              "state": "Completed",
          "AttachUserData",
+
              "subject": "On 12:58:9 11/5/2013, P created a pos...",
          "UpdateUserData",
+
              "suggestedQueueUris": [],
          "DeleteUserData",
+
              "twitterType": "Inbound",
          "SetDisposition",
+
              "uri": "http://192.168.83.25:8080/api/v2/twitters/01QQQG2MU214P05K",
          "SetInFocus",
+
              "userData": {"CBR-IT-path_DBIDs": "",
          "Transfer"
+
                            "CBR-Interaction_cost": "",
      ],
+
                            "CBR-actual_volume": "",
      "state": "Composing",
+
                            "CBR-contract_DBIDs": "",
      "id": "01QQQG2MU214P05M",
+
                            "ClassifiedAndScreened": "1",
      "twitterType": "Outbound"
+
                            "Classify_Actionability_CtgId": "",
  },
+
                            "Classify_Actionability_CtgName": "",
  "referenceId": 11,
+
                            "Classify_Actionability_CtgRelevancy": "",
  "notificationType": "PropertiesUpdated",
+
                            "Classify_Sentiment_CtgId": "",
  "messageType": "TwitterStateChangeMessage"
+
                            "Classify_Sentiment_CtgName": "",
}
+
                            "Classify_Sentiment_CtgRelevancy": "",
 +
                            "ContactCreated": "false",
 +
                            "ContactId": "0000Ka96XNNU4488",
 +
                            "ContactIdList": "0000Ka96XNNU4488",
 +
                            "CustomerSegment": "default",
 +
                            "DISP_KEY": "resolved",
 +
                            "FirstName": "Oleg",
 +
                            "FromAddress": "vitaliy_onv(Oleg Witcher)",
 +
                            "IxnAlreadyCreatedInUCS": "1",
 +
                            "KloutId": "",
 +
                            "LastName": "Witcher",
 +
                            "NumberOfContactsFound": "1",
 +
                            "PegAGSocial Media Agent Group": 1,
 +
                            "RRequestedSkillCombination": "",
 +
                            "RRequestedSkills": None,
 +
                            "RStrategyDBID": "985",
 +
                            "RStrategyName": "Twitter Agent Delivery Strategy",
 +
                            "RTargetAgentGroup": "Social Media Agent Group",
 +
                            "RTargetAgentSelected": "a1",
 +
                            "RTargetObjSelDBID": "117",
 +
                            "RTargetObjectSelected": "Social Media Agent Group",
 +
                            "RTargetPlaceSelected": "a1",
 +
                            "RTargetRequested": "Social Media Agent Group",
 +
                            "RTargetRuleSelected": "",
 +
                            "RTargetTypeSelected": "2",
 +
                            "RTenant": "Environment",
 +
                            "RVQDBID": "",
 +
                            "RVQID": "",
 +
                            "RouterData70": "("t"="1383649092 0")",
 +
                            "Screen_Actionability_CtgName": "",
 +
                            "Screen_Actionability_CtgRelevancy": "",
 +
                            "Screen_Actionability_ScreenRuleName": "",
 +
                            "Screen_Sentiment_CtgName": "",
 +
                            "Screen_Sentiment_CtgRelevancy": "",
 +
                            "Screen_Sentiment_ScreenRuleName": "",
 +
                            "ServiceObjective": 0,
 +
                            "ServiceType": "default",
 +
                            "Subject": "On 12:58:9 11/5/2013, P created a pos...",
 +
                            "_twitterCreatedAt": "2013-11-05T10:58:12Z",
 +
                            "_twitterFromAddr": "vitaliy_onv",
 +
                            "_twitterFromUserId": "2175525290",
 +
                            "_twitterIsFavorited": "false",
 +
                            "_twitterIsRetweet": "false",
 +
                            "_twitterMsgId": "63493545",
 +
                            "_twitterMsgPlainText": "On 12:58:9 11/5/2013, P created a post saying hello world!.",
 +
                            "_twitterMsgType": "Status",
 +
                            "_twitterQueryName": "stream-user",
 +
                            "_twitterRetweetCount": "0",
 +
                            "_twitterSource": "<a href="http://www.kaermorhen.ru" rel="nofollow">Witcher_APP</a>",
 +
                            "_twitterToAddr": "vitaliy_onv",
 +
                            "_twitterUserCreatedAt": "2013-11-05T06:56:43Z",
 +
                            "_twitterUserFollowersCount": "0",
 +
                            "_twitterUserFriendsCount": "0",
 +
                            "_twitterUserId": "2175525290",
 +
                            "_twitterUserImageURL": "http://abs.twimg.com/sticky/default_profile_images/default_profile_1_normal.png",
 +
                            "_twitterUserIsFollower": "false",
 +
                            "_twitterUserIsFriend": "false",
 +
                            "_twitterUserLanguage": "r",
 +
                            "_twitterUserName": "Oleg Witcher",
 +
                            "_twitterUserScreenName": "vitaliy_onv",
 +
                            "_twitterUserStatusesCount": "2",
 +
                            "_twitterUserUtcOffset": "-1",
 +
                            "_umsChannel": "channel-twitter",
 +
                            "_umsChannelInfo": {"_twitterSourceNickName": "Twitter Application SmServer-1",
 +
                                                "_twitterUserId": "2175525290",
 +
                                                "_twitterUserImageURL": "http://abs.twimg.com/sticky/default_profile_images/default_profile_1_normal.png",
 +
                                                "_twitterUserName": "Oleg Witcher",
 +
                                                "_twitterUserScreenName": "vitaliy_onv"},
 +
                            "_umsChatPossible": "false",
 +
                            "_umsFromAddr": "vitaliy_onv",
 +
                            "_umsInboundIxnSubmittedBy": "Cloud_localhost",
 +
                            "_umsMediaAccount": "2175525290",
 +
                            "_umsMediaType": "twitter",
 +
                            "_umsMsgPlainText": "On 12:58:9 11/5/2013, P created a post saying hello world!.",
 +
                            "_umsRequestId": "14",
 +
                            "desktop_actionable": "1",
 +
                            "desktop_expand": "1",
 +
                            "desktop_sentiment": "Neutral"}}}
 
</source>
 
</source>
 +
 
[[Category:V:HTCC:8.5.2DRAFT]]
 
[[Category:V:HTCC:8.5.2DRAFT]]

Revision as of 15:31, March 5, 2015

Complete

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

Overview

An agent can mark a Twitter interaction as completed. If the queuePath parameter is specified, then the Twitter interaction is placed in the specified queue.

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

Parameters

Parameter Value
operationName Complete
queuePath The URI of the queue where GWS should place this Twitter interaction. (optional)

Samples

Request

POST api/v2/me/twitter/01QQQG2MU214P05K
{
  "operationName": "Complete",
  "queuePath": "/contacts/60ebbb94-3cef-4b14-95f8-5c49dbeb355d"
}

HTTP Response

{
  "statusCode": 0
}

CometD Response

{"messageType": "TwitterStateChangeMessage",
 "notificationType": "StatusChange",
 "referenceId": 45,
 "twitter": {"capabilities": [],
              "contactId": "0000Ka96XNNU4488",
              "from": "vitaliy_onv(Oleg Witcher)",
              "id": "01QQQG2MU214P05K",
              "message": "On 12:58:9 11/5/2013, P created a post saying hello world!.",
              "receivedDate": "2015-03-02 12:26:14.000+0200",
              "revelantResponseTemplateGroups": [],
              "state": "Completed",
              "subject": "On 12:58:9 11/5/2013, P created a pos...",
              "suggestedQueueUris": [],
              "twitterType": "Inbound",
              "uri": "http://192.168.83.25:8080/api/v2/twitters/01QQQG2MU214P05K",
              "userData": {"CBR-IT-path_DBIDs": "",
                            "CBR-Interaction_cost": "",
                            "CBR-actual_volume": "",
                            "CBR-contract_DBIDs": "",
                            "ClassifiedAndScreened": "1",
                            "Classify_Actionability_CtgId": "",
                            "Classify_Actionability_CtgName": "",
                            "Classify_Actionability_CtgRelevancy": "",
                            "Classify_Sentiment_CtgId": "",
                            "Classify_Sentiment_CtgName": "",
                            "Classify_Sentiment_CtgRelevancy": "",
                            "ContactCreated": "false",
                            "ContactId": "0000Ka96XNNU4488",
                            "ContactIdList": "0000Ka96XNNU4488",
                            "CustomerSegment": "default",
                            "DISP_KEY": "resolved",
                            "FirstName": "Oleg",
                            "FromAddress": "vitaliy_onv(Oleg Witcher)",
                            "IxnAlreadyCreatedInUCS": "1",
                            "KloutId": "",
                            "LastName": "Witcher",
                            "NumberOfContactsFound": "1",
                            "PegAGSocial Media Agent Group": 1,
                            "RRequestedSkillCombination": "",
                            "RRequestedSkills": None,
                            "RStrategyDBID": "985",
                            "RStrategyName": "Twitter Agent Delivery Strategy",
                            "RTargetAgentGroup": "Social Media Agent Group",
                            "RTargetAgentSelected": "a1",
                            "RTargetObjSelDBID": "117",
                            "RTargetObjectSelected": "Social Media Agent Group",
                            "RTargetPlaceSelected": "a1",
                            "RTargetRequested": "Social Media Agent Group",
                            "RTargetRuleSelected": "",
                            "RTargetTypeSelected": "2",
                            "RTenant": "Environment",
                            "RVQDBID": "",
                            "RVQID": "",
                            "RouterData70": "("t"="1383649092 0")",
                            "Screen_Actionability_CtgName": "",
                            "Screen_Actionability_CtgRelevancy": "",
                            "Screen_Actionability_ScreenRuleName": "",
                            "Screen_Sentiment_CtgName": "",
                            "Screen_Sentiment_CtgRelevancy": "",
                            "Screen_Sentiment_ScreenRuleName": "",
                            "ServiceObjective": 0,
                            "ServiceType": "default",
                            "Subject": "On 12:58:9 11/5/2013, P created a pos...",
                            "_twitterCreatedAt": "2013-11-05T10:58:12Z",
                            "_twitterFromAddr": "vitaliy_onv",
                            "_twitterFromUserId": "2175525290",
                            "_twitterIsFavorited": "false",
                            "_twitterIsRetweet": "false",
                            "_twitterMsgId": "63493545",
                            "_twitterMsgPlainText": "On 12:58:9 11/5/2013, P created a post saying hello world!.",
                            "_twitterMsgType": "Status",
                            "_twitterQueryName": "stream-user",
                            "_twitterRetweetCount": "0",
                            "_twitterSource": "<a href="http://www.kaermorhen.ru" rel="nofollow">Witcher_APP</a>",
                            "_twitterToAddr": "vitaliy_onv",
                            "_twitterUserCreatedAt": "2013-11-05T06:56:43Z",
                            "_twitterUserFollowersCount": "0",
                            "_twitterUserFriendsCount": "0",
                            "_twitterUserId": "2175525290",
                            "_twitterUserImageURL": "http://abs.twimg.com/sticky/default_profile_images/default_profile_1_normal.png",
                            "_twitterUserIsFollower": "false",
                            "_twitterUserIsFriend": "false",
                            "_twitterUserLanguage": "r",
                            "_twitterUserName": "Oleg Witcher",
                            "_twitterUserScreenName": "vitaliy_onv",
                            "_twitterUserStatusesCount": "2",
                            "_twitterUserUtcOffset": "-1",
                            "_umsChannel": "channel-twitter",
                            "_umsChannelInfo": {"_twitterSourceNickName": "Twitter Application SmServer-1",
                                                 "_twitterUserId": "2175525290",
                                                 "_twitterUserImageURL": "http://abs.twimg.com/sticky/default_profile_images/default_profile_1_normal.png",
                                                 "_twitterUserName": "Oleg Witcher",
                                                 "_twitterUserScreenName": "vitaliy_onv"},
                            "_umsChatPossible": "false",
                            "_umsFromAddr": "vitaliy_onv",
                            "_umsInboundIxnSubmittedBy": "Cloud_localhost",
                            "_umsMediaAccount": "2175525290",
                            "_umsMediaType": "twitter",
                            "_umsMsgPlainText": "On 12:58:9 11/5/2013, P created a post saying hello world!.",
                            "_umsRequestId": "14",
                            "desktop_actionable": "1",
                            "desktop_expand": "1",
                            "desktop_sentiment": "Neutral"}}}
Comments or questions about this documentation? Contact us for support!