Get Agent Information
    • Dark
      Light
    • PDF

    Get Agent Information

    • Dark
      Light
    • PDF

    Article summary

    Get
    /api/v1/livechat/agent.info/{rid}/{token}

    Get the Livechat agent data according to the path variables. To get the rid and token values, call the Get Rooms endpoint to retrieve the details of all rooms.

    Path parameters
    rid
    stringRequired

    The room ID.

    ExamplezRAeTszXor8CCPceB
    token
    stringRequired

    The visitor token.

    ExampleiNKE8a6k6cjbqWhWd
    Responses
    200

    OK

    Success Example
    {
      "agent": {
        "_id": "XycfA5CetCPuEjqxw",
        "emails": [
          {
            "address": "[email protected]",
            "verified": true
          }
        ],
        "status": "online",
        "name": "testAgent",
        "username": "test.agent",
        "livechat": {
          "maxNumberSimultaneousChat": "5"
        }
      },
      "success": true
    }
    Expand All
    object
    agent
    object
    _id
    string
    emails
    Array of object
    object
    address
    string
    verified
    boolean
    status
    string
    name
    string
    username
    string
    livechat
    object
    maxNumberSimultaneousChat
    string
    success
    boolean

    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.