Agents¶

Synopsis¶

Response event in a series to the Agents AMI action containing information about a defined agent.

Description¶

The channel snapshot is present if the Status value is 'AGENT_IDLE' or 'AGENT_ONCALL'.

Syntax¶

    Event: Agents
    Agent: <value>
    Name: <value>
    Status: <value>
    TalkingToChan: <value>
    CallStarted: <value>
    LoggedInTime: <value>
    Channel: <value>
    ChannelState: <value>
    ChannelStateDesc: <value>
    CallerIDNum: <value>
    CallerIDName: <value>
    ConnectedLineNum: <value>
    ConnectedLineName: <value>
    Language: <value>
    AccountCode: <value>
    Context: <value>
    Exten: <value>
    Priority: <value>
    Uniqueid: <value>
    Linkedid: <value>
    ActionID: <value>

Arguments¶

Agent - Agent ID of the agent.
Name - User friendly name of the agent.
Status - Current status of the agent.
The valid values are:
- AGENT_LOGGEDOFF
- AGENT_IDLE
- AGENT_ONCALL
TalkingToChan - BRIDGEPEER value on agent channel.
Present if Status value is 'AGENT_ONCALL'.
CallStarted - Epoche time when the agent started talking with the caller.
Present if Status value is 'AGENT_ONCALL'.
LoggedInTime - Epoche time when the agent logged in.
Present if Status value is 'AGENT_IDLE' or 'AGENT_ONCALL'.
Channel
ChannelState - A numeric code for the channel's current state, related to ChannelStateDesc
ChannelStateDesc
- Down
- Rsrvd
- OffHook
- Dialing
- Ring
- Ringing
- Up
- Busy
- Dialing Offhook
- Pre-ring
- Unknown
CallerIDNum
CallerIDName
ConnectedLineNum
ConnectedLineName
Language
AccountCode
Context
Exten
Priority
Uniqueid
Linkedid - Uniqueid of the oldest channel associated with this channel.
ActionID - ActionID for this transaction. Will be returned.

Class¶

AGENT

Generated Version¶

This documentation was generated from Asterisk branch certified/18.9 using version GIT