Jump to: navigation, search

Unsubscribe from Group Workbin Notifications

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

Unsubscribe from an AgentGroup Workbin's Notifications

Unsubscribes from CometD notifications for the specified AgentGroup workbin.

Request URL /api/v2/me/workbins/{id}?agentGroup={agentGroupName}
HTTP method POST
Required features api-multimedia

Parameters

Parameter Value
operationName Unsubscribe

Sample

Request

POST api/v2/me/workbins/6c715fa9-de16-4d23-b07c-cbcb1caf3e07?agentGroup=MyAgentGroup
{
    "operationName": "Unsubscribe"
}

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": 80
}

CometD notification

{
    "agentGroup": "MyAgentGroup",
    "id": "6c715fa9-de16-4d23-b07c-cbcb1caf3e07",
    "messageType": "WorkbinSubscriptionStateChangeMessage",
    "referenceId": 80,
    "stateResource": "Unsubscribed"
}

Unsubscribe from a PlaceGroup Workbin's Notifications

Unsubscribes from CometD notifications for the specified PlaceGroup workbin.

Request URL /api/v2/me/workbins/{id}?placeGroup={placeGroupName}
HTTP method POST
Required features api-multimedia

Parameters

Parameter Value
operationName Unsubscribe

Sample

Request

api/v2/me/workbins/5d487e69-a393-4228-a06f-6a4015ab1b54?placeGroup=MyPlaceGroup
{
    "operationName": "Unubscribe"
}

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": 21
}

CometD notification

{
    "id": "5d487e69-a393-4228-a06f-6a4015ab1b54",
    "messageType": "WorkbinSubscriptionStateChangeMessage",
    "referenceId": 21,
    "stateResource": "Unsubscribed"
}

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on June 10, 2016, at 11:42.