Jump to: navigation, search
(→‎Accept)
(Update with the copy of version: 8.5.2DRAFT)
Line 1: Line 1:
 
=Accept=
 
=Accept=
 
__NOTOC__
 
__NOTOC__
 +
This operation is part of the [[Twitter|Twitter API]] section of the [[Welcome|Genesys Web Services REST API]].
 +
==Overview==
 +
Notifies the service that the agent has accepted an interaction invitation.
 +
{|
 +
! Request URL
 +
| /api/v2/me/twitter/{id}
 +
|-
 +
! HTTP Method
 +
| POST
 +
|-
 +
! Required Features
 +
| api-multimedia
 +
|}
  
−
This operation can be performed, after a new Interaction invitation notification arrives. It is essentially one of two options an agent (user) has regarding an Interaction invitation: accepting it or rejecting it. Choosing this action will associate the Interaction to the agent. This association or "ownership" will continue until that agent performs a Complete, Transfer, or Re-direct action on the aforementioned Interaction. A successful request will result in an empty http-200 response. The true response will arrive on the cometd topic (channel) /me/interactions/
+
==Parameters==
 +
{|
 +
! Parameter
 +
! Value
 +
|-
 +
| operationName
 +
| Accept
 +
|}
  
−
== HTTP Request ==
+
==Samples==
−
 
+
===Request===
−
POST on '''/me/interaction/{id}'''
+
<source lang="text">
−
<pre>
+
POST /api/v2/me/twitter/01QQQG2MU214P05F
 
{
 
{
−
   "operationName":"Accept"
+
   "operationName": "Accept"
 
}
 
}
−
</pre>
+
</source>
−
== HTTP Response ==
+
===HTTP Response===
−
 
+
<source lang="text">
−
===Success===
 
−
<pre>
 
 
{
 
{
−
  "statusCode": 0
+
"statusCode": 0,
 +
"referenceId": 11
 
}
 
}
−
</pre>
+
</source>
  
−
===Failure===
+
===CometD Response===
−
<pre>
+
<source lang="text">
−
{
+
{
−
  "statusCode": an integer value above 0,
+
  "messageType":"TwitterStateChangeMessage",
−
  "statusMessage":details
+
  "notificationType":"StatusChange",
−
}
+
  "referenceId":11,
−
</pre>
+
  "twitter":{ 
 +
      "capabilities":[ 
 +
        "Reply",
 +
        "Transfer",
 +
        "AddComment",
 +
        "AttachUserData",
 +
        "UpdateUserData",
 +
        "DeleteUserData",
 +
        "SetDisposition",
 +
        "SetInFocus",
 +
        "Complete"
 +
      ],
 +
      "contactId":"0000Ka96XNNU4488",
 +
      "from":"vitaliy_onv(Oleg Witcher)",
 +
      "id":"01QQQG2MU214P05F",
 +
      "message":"On 12:58:9 11/5/2013, P created a post saying hello world!.",
 +
      "receivedDate":"2015-03-02 10:55:45.000+0200",
 +
      "revelantResponseTemplateGroups":[ 
  
−
For details on the statusCode value, please refer to the All Methods sub-section of the Return Values section.
+
      ],
 +
      "state":"Processing",
 +
      "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/01QQQG2MU214P05F",
 +
      "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",
 +
        "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":"25760829",
 +
        "_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>
  
 +
{|
 +
! '''Field'''
 +
! '''Description'''
 +
|-
 +
| messageType
 +
| The category of message.
 +
|-
 +
| notificationType
 +
| The purpose of the notification.
 +
|-
 +
| uri
 +
| The location of the resource.
 +
|-
 +
| twitter
 +
| The element containing all twitter specific data.
 +
|}
 
[[Category:V:HTCC:8.5.2]]
 
[[Category:V:HTCC:8.5.2]]

Revision as of 18:40, April 3, 2015

Accept

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

Overview

Notifies the service that the agent has accepted an interaction invitation.

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

Parameters

Parameter Value
operationName Accept

Samples

Request

POST /api/v2/me/twitter/01QQQG2MU214P05F
{
  "operationName": "Accept"
}

HTTP Response

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

CometD Response

{  
   "messageType":"TwitterStateChangeMessage",
   "notificationType":"StatusChange",
   "referenceId":11,
   "twitter":{  
      "capabilities":[  
         "Reply",
         "Transfer",
         "AddComment",
         "AttachUserData",
         "UpdateUserData",
         "DeleteUserData",
         "SetDisposition",
         "SetInFocus",
         "Complete"
      ],
      "contactId":"0000Ka96XNNU4488",
      "from":"vitaliy_onv(Oleg Witcher)",
      "id":"01QQQG2MU214P05F",
      "message":"On 12:58:9 11/5/2013, P created a post saying hello world!.",
      "receivedDate":"2015-03-02 10:55:45.000+0200",
      "revelantResponseTemplateGroups":[  

      ],
      "state":"Processing",
      "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/01QQQG2MU214P05F",
      "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",
         "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":"25760829",
         "_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"
      }
   }
}
Field Description
messageType The category of message.
notificationType The purpose of the notification.
uri The location of the resource.
twitter The element containing all twitter specific data.
Comments or questions about this documentation? Contact us for support!