Move an Agent to Not Ready
    • Dark
      Light

    Move an Agent to Not Ready

    • Dark
      Light

    Article summary

    Overview

    This API allows a Supervisor to move an Agent to the Not Ready state.

    Pre-requisite

    The agent must be logged in to application.

    Sequence Diagram

    Message Structure

    Request Parameters

    Value

    channel

    Cisco

    topic

    Team

    subtopic

    SetTeamAgentNotReadyState

    source

    «app-name-broadcasting-this-message»

    data

    «JSON Object»

    Data Parameters

    Parameter

    Data Type

    Description

    Sample Value

    UserName

    String

    The agent ID.

    102312778

    State

    String

    The agent state.

    NotReady

    ReasonCodeId

    String

    The Reason Code ID for the agent moving to this state.

    -1

    Sample Request

    {
        "channel": "Cisco",
        "topic": "Team",
        "subtopic": "SetTeamAgentNotReadyState"
        "data": 
        {        
            "Username": "311640960",
            "State": "NotReady",
           "ReasonCodeId": "-1"    
        }
    }

    Sample Response

    No sample response


    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.