GetWorkbinSubresources by User

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

Overview

Agent can get emails, chats, and workitems for a given workbin.

Parameters

Request URL	/api/v2/{userId}/workbins/{workbinId}/{mediaType}?subresources=*
HTTP Method	GET
Required Features	api-multimedia

Samples

Request

Below are valid sample requests:

Email
The following request returns email interaction sub-resources.

GET api/v2/b15862cq-2445-4735-bba2-69694p0g50qq/workbins/a15862be-2445-4735-aad2-69694a0f50ff/emails?subresources=*

Chat
The following request returns chat interaction sub-resources.

GET api/v2/b15862cq-2445-4735-bba2-69694p0g50qq/workbins/a15862be-2445-4735-aad2-69694a0f50ff/chats?subresources=*

Workitem
The following request returns workitem interaction sub-resources.

GET api/v2/b15862cq-2445-4735-bba2-69694p0g50qq/workbins/a15862be-2445-4735-aad2-69694a0f50ff/workitems?subresources=*

Response

For details on the result, please refer to the Workbin Resource reference.

HTTP response

Below are a list of possible HTTP responses based on the given media type:

Email

{
    "statusCode": 0,
    "workbin": {
           "name": "Workbin_AgentGroup",
           "id": "a15862be-2445-4735-aad2-69694a0f50ff",
           "displayName": "Workbin_AgentGroup",
           "uri": "http://.../api/v2/b15862cq-2445-4735-bba2-69694p0g50qq/workbins/a15862be-2445-4735-aad2-69694a0f50ff",
           "type": "PlaceGroup"
           "emails": {
                ...
           }
    }
}

Chat

{
    "statusCode": 0,
    "workbin": {
           "workbinName": "Workbin_AgentGroup",
           "id": "a15862be-2445-4735-aad2-69694a0f50ff",
           "displayName": "Workbin_AgentGroup",
           "uri": "http://.../api/v2/b15862cq-2445-4735-bba2-69694p0g50qq/workbins/a15862be-2445-4735-aad2-69694a0f50ff",
           "type": "PlaceGroup"
           "chats": {
                ...
           }
    }
}

Workitem

{
    "statusCode": 0,
    "workbin": {
           "workbinName": "Workbin_AgentGroup",
           "id": "a15862be-2445-4735-aad2-69694a0f50ff",
           "displayName": "Workbin_AgentGroup",
           "uri": "http://.../api/v2/b15862cq-2445-4735-bba2-69694p0g50qq/workbins/a15862be-2445-4735-aad2-69694a0f50ff",
           "type": "PlaceGroup"
           "workitems": {
                ...
           }
    }
}