| Line 1: | Line 1: | ||
= PullInteraction from a Group Workbin= | = PullInteraction from a Group Workbin= | ||
This operation is part of the [[Workbins|Workbins API]] section of the [[Welcome|Web Services API]]. | This operation is part of the [[Workbins|Workbins API]] section of the [[Welcome|Web Services API]]. | ||
| − | == | + | ==PullInteraction from an AgentGroup Workbin== |
| − | Removes the association between an interaction and | + | Removes the association between an interaction and an AgentGroup workbin. |
{| | {| | ||
! Request URL | ! Request URL | ||
| /api/v2/me/workbins/''{id}''?agentGroup=''{agentGroupName}'' | | /api/v2/me/workbins/''{id}''?agentGroup=''{agentGroupName}'' | ||
| − | |||
| − | |||
|- | |- | ||
! HTTP method | ! HTTP method | ||
| Line 16: | Line 14: | ||
|} | |} | ||
| − | ==Parameters== | + | ===Parameters=== |
{| | {| | ||
! Parameter | ! Parameter | ||
| Line 28: | Line 26: | ||
|} | |} | ||
| − | ==Sample | + | ===Sample=== |
| − | ===Request=== | + | ====Request==== |
<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 | ||
| Line 37: | Line 35: | ||
} | } | ||
</source> | </source> | ||
| − | ===HTTP response=== | + | |
| + | ====HTTP response==== | ||
The response consists of an HTTP response and a CometD response. For details on the result, refer to the [[WorkbinResource|workbin resource]]. | The response consists of an HTTP response and a CometD response. For details on the result, refer to the [[WorkbinResource|workbin resource]]. | ||
<source lang="text"> | <source lang="text"> | ||
| Line 45: | Line 44: | ||
} | } | ||
</source> | </source> | ||
| − | ===CometD notification=== | + | |
| + | ====CometD notification==== | ||
<source lang="text"> | <source lang="text"> | ||
{ | { | ||
| Line 90: | Line 90: | ||
</source> | </source> | ||
| − | == | + | ==PullInteraction from a PlaceGroup Workbin== |
| − | ===Request=== | + | 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. Also valid values are: PullChat, PullEmail, PullWorkitem, PullTweet, PullFacebook, PullFacebooksession and PullOpenmedia. | ||
| + | |- | ||
| + | | id | ||
| + | | The ID of the interaction to remove from the workbin. | ||
| + | |} | ||
| + | |||
| + | ===Sample=== | ||
| + | ====Request==== | ||
<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 | ||
| Line 99: | Line 124: | ||
} | } | ||
</source> | </source> | ||
| − | ===HTTP response=== | + | |
| + | ====HTTP response==== | ||
The response consists of an HTTP response and a CometD response. For details on the result, refer to the [[WorkbinResource|workbin resource]]. | The response consists of an HTTP response and a CometD response. For details on the result, refer to the [[WorkbinResource|workbin resource]]. | ||
<source lang="text"> | <source lang="text"> | ||
| Line 107: | Line 133: | ||
} | } | ||
</source> | </source> | ||
| − | ===CometD notification=== | + | |
| + | ====CometD notification==== | ||
<source lang="text"> | <source lang="text"> | ||
{ | { | ||
Revision as of 12:53, May 9, 2016
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. Also valid values are: PullChat, PullEmail, PullWorkitem, PullTweet, PullFacebook, PullFacebooksession and PullOpenmedia. |
| id | The ID of the interaction to remove from the workbin. |
Sample
Request
POST api/v2/me/workbins/6c715fa9-de16-4d23-b07c-cbcb1caf3e07?agentGroup=MyAgentGroup
{
"operationName": "PullChat",
"id": "0001BaBFVPR20035"
}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"
}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. Also valid values are: PullChat, PullEmail, PullWorkitem, PullTweet, PullFacebook, PullFacebooksession and PullOpenmedia. |
| id | The ID of the interaction to remove from the workbin. |
Sample
Request
POST api/v2/me/workbins/5d487e69-a393-4228-a06f-6a4015ab1b54?placeGroup=MyPlaceGroup
{
"operationName": "PullChat",
"id": "0001BaBFVPR20039"
}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"
}
Comments or questions about this documentation? Contact us for support!