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. | |
{| | {| | ||
! Request URL | ! Request URL | ||
Line 21: | Line 21: | ||
|- | |- | ||
| operationName | | operationName | ||
− | | | + | | AttachUserData |
|- | |- | ||
| userData | | userData | ||
− | | The key value data to | + | | The key value data to attach. |
|} | |} | ||
Line 32: | Line 32: | ||
POST api/v2/me/twitter/01QQQG2MU214P05N | POST api/v2/me/twitter/01QQQG2MU214P05N | ||
{ | { | ||
− | "operationName": " | + | "operationName": "AttachUserData", |
"userData": { | "userData": { | ||
− | "UserData1": | + | "UserData1":"DATA1", |
− | "UserData2": | + | "UserData2":123456789 |
} | } | ||
} | } | ||
Line 46: | Line 46: | ||
</source> | </source> | ||
===CometD Response=== | ===CometD Response=== | ||
+ | ====Message for Processing a Twitter Interaction==== | ||
<source lang="text"> | <source lang="text"> | ||
{ | { | ||
Line 92: | Line 93: | ||
"_umsMediaAccount": "2175525290", | "_umsMediaAccount": "2175525290", | ||
"PegAGSocialMediaAgentGroup": 1, | "PegAGSocialMediaAgentGroup": 1, | ||
− | "UserData2": | + | "UserData2": 123456789, |
"RTargetPlaceSelected": "a1", | "RTargetPlaceSelected": "a1", | ||
"ContactCreated": "false", | "ContactCreated": "false", | ||
− | "UserData1": | + | "UserData1": "DATA1", |
"ContactIdList": "0000Ka96XNNU4488", | "ContactIdList": "0000Ka96XNNU4488", | ||
"RTenant": "Environment", | "RTenant": "Environment", | ||
Line 174: | Line 175: | ||
Pcreatedapos..." | Pcreatedapos..." | ||
}, | }, | ||
− | "referenceId": | + | "referenceId": 27, |
+ | "notificationType": "PropertiesUpdated", | ||
+ | "messageType": "TwitterStateChangeMessage" | ||
+ | } | ||
+ | </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", | "notificationType": "PropertiesUpdated", | ||
"messageType": "TwitterStateChangeMessage" | "messageType": "TwitterStateChangeMessage" |
Revision as of 15:12, March 5, 2015
AttachUserData
This operation is part of the Twitter API section of the Genesys Web Services REST API.
Overview
Adds the specified data to the interaction's UserData.
Request URL | /api/v2/me/twitter/{id} |
---|---|
HTTP Method | POST |
Required Features | api-multimedia |
Parameters
Parameter | Value |
---|---|
operationName | AttachUserData |
userData | The key value data to attach. |
Samples
Request
POST api/v2/me/twitter/01QQQG2MU214P05N
{
"operationName": "AttachUserData",
"userData": {
"UserData1":"DATA1",
"UserData2":123456789
}
}
HTTP Response
{
"statusCode": 0
}
CometD Response
Message for Processing a Twitter Interaction
{
"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"
}
Message for Composing a Twitter Interaction
{
"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"
}
Comments or questions about this documentation? Contact us for support!