As of Friday October 16th, access to restricted content on this site now requires you to log in with your Genesys account. If you don't have an account, you can request one at these locations: Request MyPartner Portal Account or Request My Support Account.
Jump to: navigation, search


This operation is part of the Supervisor Agent State Control API section of the Web Services API.


With this request, the supervisor can set the agent's status to Offline.

Request URL /api/v2/users/{userId}/channels/{channelId}
HTTP method POST
Required features api-supervisor-agent-control

Valid values for channelId are voice, chat, email, and other defined media types.


Parameter Value
operationName Offline



POST api/v2/users/2d96456349284f45b6bc58790ccbd729/channels/chat
  "operationName": "Offline"

HTTP response

  "statusCode": "0",


The agent whose state has been updated receives notification:

  "channel": "/v2/me/channels",
  "data": {
    "channels": [
        "channel": "chat",
        "userState": {
          "displayName": "Offline",
          "id": "0F7F5003-EF26-4D13-A6Ef-D0C7EC819BEB",
          "state": "LoggedOut"
    "messageType": "ChannelStateChangeMessageV2"
This page was last edited on May 19, 2017, at 17:16.


Comment on this article:

blog comments powered by Disqus