Skip to content

AgentLogin()

Synopsis

Login an agent.

Description

Login an agent to the system. Any agent authentication is assumed to already be done by dialplan. While logged in, the agent can receive calls and will hear the sound file specified by the config option custom_beep when a new call comes in for the agent. Login failures will continue in the dialplan with AGENT_STATUS set.

Before logging in, you can setup on the real agent channel the CHANNEL(dtmf_features) an agent will have when talking to a caller and you can setup on the channel running this application the CONNECTEDLINE() information the agent will see while waiting for a caller.

AGENT_STATUS enumeration values:

  • INVALID - The specified agent is invalid.

  • ALREADY_LOGGED_IN - The agent is already logged in.

Note

The Agent:AgentId device state is available to monitor the status of the agent.

Syntax

AgentLogin(AgentId,[options])
Arguments

  • AgentId

  • options

    • s - silent login - do not announce the login ok segment after agent logged on.

See Also

Generated Version

This documentation was generated from Asterisk branch 22 using version GIT