Skip to Content

Agent Management – Log in to or Log out of Queues

Log in or log out the specified dynamic agent from one or more queues.

Request URL

GET {base_url}/{api_path}/agent/login?access_token={access_token}

Request parameters

ParameterRequiredTypeDescription
ext_idYesIntegerThe extension ID of the dynamic agent.
Note: You can query agent's extension ID using Search Specific Extensions.
queue_idsNoStringImportant: If this parameter is not included, the system will log the agent in or out of all queues.
The unique ID(s) of the queue(s) that the agent needs to log in or log out of.
Note:
operationYesStringLog in to or log out the dynamic agent from the specified queue(s).
Valid value:
  • login: Log the agent in to the queue(s).
  • logout: Log the agent out of the queue(s).
is_pausedNoIntegerWhether to pause service for the dynamic agent after logging him or her to the queue.
Valid value:
  • 0: Do NOT pause service for the agent after logging him or her to the queue(s).
  • 1: Pause service for the agent after logging him or her to the queue(s).
Note: If you don't configure this parameter, it will be filled with the default value 0.
max_threshold_for_pause_timeNoIntegerThe amount of time in seconds that the dynamic agent will pause service.
Valid value:
  • 0: Remain paused unless a new request is made to unpause service for the agent.
  • 10 or greater: The specific pause time. After the timeout, automatically unpause service for the agent.
max_threshold_for_logout_timeNoIntegerThe amount of time in seconds that the dynamic agent will log out from the queue.

Valid value:

  • 0: Remain logout unless a new request is made to log the agent to the queue.
  • 10 or greater: The specific logout time. After the timeout, automatically log the agent to the queue.
reasonNoStringFeature code for the pause reason.
Valid value: The feature code for the existing pause reasons on PBX.
Note:
  • If the PBX plan subscription is NOT Enterprise Plan or Ultimate Plan, do NOT pass this parameter, otherwise the request will fail.
  • You can query the feature code for the existing pause reasons using Query Queue Pause Reason List.
is_login_lastNoIntegerWhether to automatically log in to previously logged-in queues.
Valid value:
  • 0: Disabled. Only log in to the specified queue(s).
  • 1: Enabled. Log in to all previously logged-in queues.

Response parameters

ParameterTypeDescription
errcodeIntegerReturned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsgStringReturned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.

Examples

Request example 1

Log in the dynamic agent (Extension ID: 85) to all his or her assigned queues, and pause service for the agent for one minute after login.

GET /openapi/v1.0/agent/login?access_token=u6UfsayUeBpUrwwpaBs6hkDeCzEE6D6t&ext_id=85&operation=login&is_paused=1&max_threshold_for_pause_time=60 HTTP/1.1
Host: 192.168.5.150:8088

Request example 2

Log in to previously logged-in queues.

GET /openapi/v1.0/agent/login?access_token=LX9r6xHhCXSUeTS0UoIQe8zJZ3FTIAZs&ext_id=50&operation=login&is_login_last=1 HTTP/1.1
Host: 192.168.5.150:8088

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS"
}