Query Agent State

Use the following to retrieve information about agent states.

Important

The Output shown in the following examples might not be applicable to your deployment.

Overall User State

Returns all of a User's device and channel states.

Input Parameters

GET on /me?subresources=*

N/A

Output

Success

{
devices: [{
...
id: idOne,
userState: {
state: "NotReady",
reason: "Lunch",
displayName: "Out to Lunch"
workMode: “AuxWork”
}
... // other device properties
}
],
channels [{
channel: "email",
userState: {
state: "NotReady",
reason: "Lunch"
displayName: "Out to Lunch"
},
... // other channel properties
}, {
channel: "chat",
userState: {
state: "NotReady",
reasonCode: "Lunch"
displayName: "Out to Lunch"
},
...
}]
...
} 

Failure

{
"status":"error",
"errorDescription":details
} 

Get All Devices

Returns all of a User's device states.

Input Parameters

GET on /me/devices

N/A

Output

Success

{
devices: [{
...
id: idOne
userState: {
state: "NotReady",
reason: "Lunch",
displayName: "Out to Lunch"
workMode: “AuxWork”
}
... // other device properties
}, 
{      ...
id: idTwo
userState: {
state: "NotReady",
reason: "Lunch",
displayName: "Out to Lunch"
workMode: “AuxWork”
}
... // other device properties
} 
] 
} 

Failure

{
"status":"error",
"errorDescription":details
} 

Get a Particular Device

Returns a User's specific device state.

Input Parameters

GET on /me/devices/{id}

N/A

Output

Success

 {
device: {
...
id: idOne
userState: {
state: "NotReady",
reason: "Lunch",
displayName: "Out to Lunch"
workMode: “AuxWork”
}
... // other device properties
} 

Failure

{
"status":"error",
"errorDescription":details
} 

Get All Multimedia Channels

Returns all of a User's channel states.

file:important.png Pre-Release Notice: The information contained in this section is not considered final and is managed under the terms and conditions found in the Pre-release Agreement. This section provides the most up-to-date reference information available for this pre-release version and is restricted for use by those who have signed the Pre-release Agreement with Genesys to acquire an early version of the software.

Input Parameters

GET on /me/channels

N/A

Output

Success

{
channels: [{
channel: "email",
userState: {
state: "NotReady",
reason: "Lunch"
displayName: "Out to Lunch"
},
... // other channel properties
}, {
channel: "chat",
userState: {
state: "NotReady",
reason: "Lunch"
displayName: "Out to Lunch"
},
...
}]
} 

Failed

{
"status":"error",
"errorDescription":details
} 

Get a Particular Multimedia Channel

Returns a User's channel state, given a channelId.

file:important.png Pre-Release Notice: The information contained in this section is not considered final and is managed under the terms and conditions found in the Pre-release Agreement. This section provides the most up-to-date reference information available for this pre-release version and is restricted for use by those who have signed the Pre-release Agreement with Genesys to acquire an early version of the software.

Input Parameters

GET on /me/channels/{channelId}

N/A

Output

Success

{
channel: {
channel: "email",
userState: {
state: "NotReady",
reason: "Lunch"
displayName: "Out to Lunch"
},
... // other channel properties
} 

Failed

{
"status":"error",
"errorDescription":details
}