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

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

Complete

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

Overview

Marks 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/tweets/{id}
HTTP Method POST
Required Features api-multimedia

Parameters

Parameter Value
operationName Complete
queuePath The URI of the queue where Web Services should place this Twitter interaction. (optional)
saveLAR Possible values are true or false. If true, information about the agent performing the operation is set in the Contact Profile so that it can be used for last agent routing. (optional)

Samples

Request

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

HTTP Response

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

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/tweet/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"
      }
   }
}
This page was last edited on June 23, 2020, at 07:11.
Comments or questions about this documentation? Contact us for support!