Login
    Contents x
    Send Agent State
      • Dark
        Light
      Contents

      Send Agent State

        • Dark
          Light
        Article summary

        Overview

        This API is used to update the Agent Status into LCM database. This method is used essentially when the AEM feature notifies the AEM service that the Agent is available to handle AEM campaigns.

        Pre-requisite

        The agent must be logged in to the application.

        Sequence Diagram

        Message Structure

        Request Parameters

        Value

        channel

        LCM

        topic

        Webservice

        subtopic

        SendAgentState

        source

        «app-name-broadcasting-this-message»

        data

        «JSON Object»

        Data Parameters

        Parameter

        Mandatory

        Data Type

        Description

        agentID

        Yes

        String

        The agent ID of the logged-in user.

        agentState

        Yes

        String

        Current state of the logged-in agent.

        Sample Request

        {
    "channel": "LCM",
    "topic": "WebService",
    "subtopic": "SendAgentState",
    "data": {
        "agentID": "834108959",
        "agentState": "NOT_READY"
    }
}

        Sample Response

        Not applicable for this API method.

        Was this article helpful?
        What's Next
        Change password!
        Changing your password will log you out immediately. Use the new password to log back in.
        Change profile
        Success!
        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.
        Logout