| (18 intermediate revisions by 2 users not shown) | |||
| Line 20: | Line 20: | ||
|- | |- | ||
| operationName | | operationName | ||
| − | | PullInteraction. | + | | PullInteraction. Other valid values are: PullChat, PullEmail, PullWorkitem, PullTweet, PullFacebook, PullFacebooksession and PullOpenmedia. |
|- | |- | ||
| id | | id | ||
| The ID of the interaction to remove from the workbin. | | The ID of the interaction to remove from the workbin. | ||
| + | |- | ||
| + | | nickname | ||
| + | | The agent nickname as displayed to the customer. Used for PullChat only. | ||
|} | |} | ||
===Sample=== | ===Sample=== | ||
====Request==== | ====Request==== | ||
| + | The request involves sending a JSON body as well as adhering to the url path listed above. | ||
<source lang="text"> | <source lang="text"> | ||
POST api/v2/me/workbins/6c715fa9-de16-4d23-b07c-cbcb1caf3e07?agentGroup=MyAgentGroup | POST api/v2/me/workbins/6c715fa9-de16-4d23-b07c-cbcb1caf3e07?agentGroup=MyAgentGroup | ||
| + | </source> | ||
| + | Listed below are possible valid JSON for requests: | ||
| + | |||
| + | '''PullInteraction''' | ||
| + | <source lang="text"> | ||
| + | { | ||
| + | "operationName": "PullInteraction", | ||
| + | "id": "FE7978FEWFE" | ||
| + | } | ||
| + | </source> | ||
| + | '''PullEmail''' | ||
| + | <source lang="text"> | ||
| + | { | ||
| + | "operationName": "PullEmail", | ||
| + | "id": "FE7978FEWFE" | ||
| + | } | ||
| + | </source> | ||
| + | '''PullWorkitem''' | ||
| + | <source lang="text"> | ||
{ | { | ||
| − | + | "operationName": "PullWorkitem", | |
| − | + | "id": "FE7978FEWFE" | |
} | } | ||
</source> | </source> | ||
| + | {{NoteFormat|To use the '''PullChat''' operation, you must enable the '''enableNotificationOnPullChat''' and '''enableJoinOnPullChat''' options. For details, refer to [[Documentation:HTCC:Dep:HTCCConfigurationOptionsReference|Web Services configuration options]].}} | ||
====HTTP response==== | ====HTTP response==== | ||
| Line 89: | Line 113: | ||
} | } | ||
</source> | </source> | ||
| − | + | ====Nickname==== | |
| + | <source lang="text"> | ||
| + | "operationName": "PullChat", | ||
| + | "id": "FE7978FEWFE", | ||
| + | "nickname": "agent-nickname-to-be-displayed-in-chat" | ||
| + | </source> | ||
==PullInteraction from a PlaceGroup Workbin== | ==PullInteraction from a PlaceGroup Workbin== | ||
Removes the association between an interaction and a PlaceGroup workbin. | Removes the association between an interaction and a PlaceGroup workbin. | ||
| Line 109: | Line 138: | ||
|- | |- | ||
| operationName | | operationName | ||
| − | | PullInteraction. | + | | PullInteraction. Other valid values are: PullChat, PullEmail, PullWorkitem, PullTweet, PullFacebook, PullFacebooksession and PullOpenmedia. |
|- | |- | ||
| id | | id | ||
| Line 117: | Line 146: | ||
===Sample=== | ===Sample=== | ||
====Request==== | ====Request==== | ||
| + | The request involves sending a JSON body as well as adhering to the url path listed above. | ||
<source lang="text"> | <source lang="text"> | ||
POST api/v2/me/workbins/5d487e69-a393-4228-a06f-6a4015ab1b54?placeGroup=MyPlaceGroup | POST api/v2/me/workbins/5d487e69-a393-4228-a06f-6a4015ab1b54?placeGroup=MyPlaceGroup | ||
| + | </source> | ||
| + | Listed below are possible valid JSON for requests: | ||
| + | |||
| + | '''PullChat''' | ||
| + | <source lang="text"> | ||
| + | |||
{ | { | ||
"operationName": "PullChat", | "operationName": "PullChat", | ||
| Line 124: | Line 160: | ||
} | } | ||
</source> | </source> | ||
| + | '''PullInteraction''' | ||
| + | <source lang="text"> | ||
| + | { | ||
| + | "operationName": "PullInteraction", | ||
| + | "id": "FE7978FEWFE" | ||
| + | } | ||
| + | </source> | ||
| + | '''PullEmail''' | ||
| + | <source lang="text"> | ||
| + | { | ||
| + | "operationName": "PullEmail", | ||
| + | "id": "FE7978FEWFE" | ||
| + | } | ||
| + | </source> | ||
| + | '''PullWorkitem''' | ||
| + | <source lang="text"> | ||
| + | { | ||
| + | "operationName": "PullWorkitem", | ||
| + | "id": "FE7978FEWFE" | ||
| + | } | ||
| + | </source> | ||
| + | {{NoteFormat|To use the '''PullChat''' operation, you must enable the '''enableNotificationOnPullChat''' and '''enableJoinOnPullChat''' options. For details, refer to [[Documentation:HTCC:Dep:HTCCConfigurationOptionsReference|Web Services configuration options]].}} | ||
====HTTP response==== | ====HTTP response==== | ||
Latest revision as of 05:05, August 20, 2020
Contents
PullInteraction from a Group Workbin
This operation is part of the Workbins API section of the Web Services API.
PullInteraction from an AgentGroup Workbin
Removes the association between an interaction and an AgentGroup workbin.
| Request URL | /api/v2/me/workbins/{id}?agentGroup={agentGroupName} |
|---|---|
| HTTP method | POST |
| Required features | api-multimedia |
Parameters
| Parameter | Value |
|---|---|
| operationName | PullInteraction. Other valid values are: PullChat, PullEmail, PullWorkitem, PullTweet, PullFacebook, PullFacebooksession and PullOpenmedia. |
| id | The ID of the interaction to remove from the workbin. |
| nickname | The agent nickname as displayed to the customer. Used for PullChat only. |
Sample
Request
The request involves sending a JSON body as well as adhering to the url path listed above.
POST api/v2/me/workbins/6c715fa9-de16-4d23-b07c-cbcb1caf3e07?agentGroup=MyAgentGroupListed below are possible valid JSON for requests:
PullInteraction
{
"operationName": "PullInteraction",
"id": "FE7978FEWFE"
}PullEmail
{
"operationName": "PullEmail",
"id": "FE7978FEWFE"
}PullWorkitem
{
"operationName": "PullWorkitem",
"id": "FE7978FEWFE"
}Important
To use the PullChat operation, you must enable the enableNotificationOnPullChat and enableJoinOnPullChat options. For details, refer to Web Services configuration options.HTTP response
The response consists of an HTTP response and a CometD response. For details on the result, refer to the workbin resource.
{
"statusCode": 0,
"referenceId": 77
}CometD notification
{
"action": "ItemRemoved",
"agentGroup": "MyAgentGroup",
"chatStateResourceV2": {"capabilities": [],
"chatType": "Inbound",
"id": "0001BaBFVPR20035",
"participants": [],
"receivedDate": "2016-04-08 15:05:57.000+0300",
"userData": {"CBR-IT-path_DBIDs": "",
"CBR-Interaction_cost": "",
"CBR-actual_volume": "",
"CBR-contract_DBIDs": "",
"ChatAnsweredByAgentAt": "2016-04-08T12:06:05Z",
"ChatServerAppName": "esv_chat_srv",
"ChatServerDBID": "147",
"ChatServerHost": "dev-ip9-152.gws.genesys.com",
"ChatServerPort": "7160",
"CustomerSegment": "default",
"OccuredAt": "2016-04-08T12:06:01Z",
"PegAG?:2>1": 1,
"RRequestedSkillCombination": "",
"RRequestedSkills": None,
"RStrategyDBID": "472",
"RStrategyName": "CloudPoDSimpleChatInStrategy",
"RTargetAgentGroup": "?:2>1",
"RTargetAgentSelected": "a1",
"RTargetObjSelDBID": "",
"RTargetObjectSelected": "?:2>1",
"RTargetPlaceSelected": "a1",
"RTargetRequested": "?:2>1",
"RTargetRuleSelected": "",
"RTargetTypeSelected": "2",
"RTenant": "Environment",
"RVQDBID": "",
"RVQID": "",
"ServiceObjective": 0,
"ServiceType": "default",
"Subject": "TestChatCustomer"}},
"id": "6c715fa9-de16-4d23-b07c-cbcb1caf3e07",
"messageType": "WorkbinStateChangeMessage"
}Nickname
"operationName": "PullChat",
"id": "FE7978FEWFE",
"nickname": "agent-nickname-to-be-displayed-in-chat"PullInteraction from a PlaceGroup Workbin
Removes the association between an interaction and a PlaceGroup workbin.
| Request URL | /api/v2/me/workbins/{id}?placeGroup={placeGroupName} |
|---|---|
| HTTP method | POST |
| Required features | api-multimedia |
Parameters
| Parameter | Value |
|---|---|
| operationName | PullInteraction. Other valid values are: PullChat, PullEmail, PullWorkitem, PullTweet, PullFacebook, PullFacebooksession and PullOpenmedia. |
| id | The ID of the interaction to remove from the workbin. |
Sample
Request
The request involves sending a JSON body as well as adhering to the url path listed above.
POST api/v2/me/workbins/5d487e69-a393-4228-a06f-6a4015ab1b54?placeGroup=MyPlaceGroupListed below are possible valid JSON for requests:
PullChat
{
"operationName": "PullChat",
"id": "0001BaBFVPR20039"
}PullInteraction
{
"operationName": "PullInteraction",
"id": "FE7978FEWFE"
}PullEmail
{
"operationName": "PullEmail",
"id": "FE7978FEWFE"
}PullWorkitem
{
"operationName": "PullWorkitem",
"id": "FE7978FEWFE"
}Important
To use the PullChat operation, you must enable the enableNotificationOnPullChat and enableJoinOnPullChat options. For details, refer to Web Services configuration options.HTTP response
The response consists of an HTTP response and a CometD response. For details on the result, refer to the workbin resource.
{
"statusCode": 0,
"referenceId": 18
}CometD notification
{
"action": "ItemRemoved",
"chatStateResourceV2": {"capabilities": [],
"chatType": "Inbound",
"id": "0001BaBFVPR20039",
"participants": [],
"receivedDate": "2016-04-08 15:31:30.000+0300",
"userData": {"CBR-IT-path_DBIDs": "",
"CBR-Interaction_cost": "",
"CBR-actual_volume": "",
"CBR-contract_DBIDs": "",
"ChatAnsweredByAgentAt": "2016-04-08T12:31:37Z",
"ChatServerAppName": "esv_chat_srv",
"ChatServerDBID": "147",
"ChatServerHost": "dev-ip9-152.gws.genesys.com",
"ChatServerPort": "7160",
"CustomerSegment": "default",
"OccuredAt": "2016-04-08T12:31:33Z",
"PegAG?:2>1": 1,
"RRequestedSkillCombination": "",
"RRequestedSkills": None,
"RStrategyDBID": "472",
"RStrategyName": "CloudPoDSimpleChatInStrategy",
"RTargetAgentGroup": "?:2>1",
"RTargetAgentSelected": "a1",
"RTargetObjSelDBID": "",
"RTargetObjectSelected": "?:2>1",
"RTargetPlaceSelected": "a1",
"RTargetRequested": "?:2>1",
"RTargetRuleSelected": "",
"RTargetTypeSelected": "2",
"RTenant": "Environment",
"RVQDBID": "",
"RVQID": "",
"ServiceObjective": 0,
"ServiceType": "default",
"Subject": "TestChatCustomer"}},
"id": "5d487e69-a393-4228-a06f-6a4015ab1b54",
"messageType": "WorkbinStateChangeMessage",
"placeGroup": "MyPlaceGroup"
} This page was last edited on August 20, 2020, at 05:05.
Comments or questions about this documentation? Contact us for support!