LinuxBox PBX API: PBX Notifications

Built: 2022-04-16 09:17:19

Event StartCall

Start call (usually for incoming call, the call has came from provider to PBX and starts to route).

Attributes:

caller_type - caller type (internal, originate, external)

caller_num - caller number

caller_userid - caller agent user ID

target_num - target number

call_id - unique call ID

cel_id - unique event ID

http://server/start_call?caller_type=internal&caller_num=591166223&caller_userid=linuxbox&target_num=591166200&call_id=1541078811.98&cel_id=28254912

Event QueueIn

Call has entered the queue.

Attributes:

caller_num - caller number

dialed_num - dialed number

queue_name - name of the queue

call_id - unique call ID

cel_id - unique event ID

http://server/queue_in?caller_num=591166223&dialed_num=591166200&queue_name=helpdesk&call_id=1541078811.98&cel_id=28254912

Event QueueOut

Call has left the queue.

Attributes:

queue_name - name of the queue

call_id - unique call ID

cel_id - unique event ID

http://server/queue_out?queue_name=helpdesk&call_id=1541078811.98&cel_id=28254912

Event StartIntDial

Start of the call ringtone on internal line.

Attributes:

caller_num - caller number

dialed_num - dialed number

line_num - number of dialed line

line_name - name of dialed line

line_userid - dialed agent user ID

custom_call_id - custom call identifier

call_id - unique call ID

cel_id - unique event ID

http://server/start_int_dial?caller_num=591166223&dialed_num=591166200&line_num=101&line_name=martin&line_userid=linuxbox&custom_call_id=Wua4kaib&call_id=1541078811.98&cel_id=28254912
                

Event StartExtDial

Start of the call ringtone on external line.

Attributes:

caller_num - caller number

dialed_num - dialed number

line_num - number of calling line

line_name - name of calling line

line_userid - user ID of calling agent

custom_call_id - custom call identifier

call_id - unique call ID

cel_id - unique event ID

http://server/start_int_dial?caller_num=591166223&dialed_num=591166200&line_num=101&line_name=martin&line_userid=linuxbox&custom_call_id=Wua4kaib&call_id=1541078811.98&cel_id=28254912
                

Event AnsweredInternalCall

The call has been picked up by internal line.

Attributes:

caller_num - caller number

dialed_num - dialed number

line_num - number of answering line

line_name - name of answering line

line_userid - user ID of answering agent

custom_call_id - custom call identifier

call_id - unique call ID

cel_id - unique event ID

http://server/start_int_dial?caller_num=591166223&dialed_num=591166200&line_num=101&line_name=martin&line_userid=linuxbox&custom_call_id=Wua4kaib&call_id=1541078811.98&cel_id=28254912
                

Event AnsweredExternalCall

The call has been picked up by remote side.

Attributes:

caller_num - caller number

dialed_num - dialed number

line_num - number of calling line

line_userid - user ID of answering agent

custom_call_id - custom call identifier

call_id - unique call ID

cel_id - unique event ID

http://server/start_int_dial?caller_num=591166223&dialed_num=591166200&line_num=101&line_name=martin&line_userid=linuxbox&custom_call_id=Wua4kaib&call_id=1541078811.98&cel_id=28254912
                    

Event Hangup

Hang-up of the call.

Attributes:

line_num - number of hanged line

line_userid - user ID of agent on hanged line

custom_call_id - custom call identifier

call_id - unique call ID

cel_id - unique event ID

http://server/hangup_internal?line_num=101&line_userid=linuxbox&custom_call_id=Wua4kaib&call_id=1541078811.98&cel_id=28254912

Event CallEnd

End of the call.

Attributes:

call_id - unique call ID

cel_id - unique event ID

custom_call_id - custom call identifier

http://server/call_end?call_id=1541078811.98&cel_id=28254912&custom_call_id=Wua4kaib

Event AgentLogin

Agent has been logged in.

Attributes:

userid - agent user ID

exten - agent extension

http://server/agent_login?userid=linuxbox&exten=121

Event AgentLogout

Agent has been logged out.

Attributes:

userid - agent user ID

reason - logout reason

http://server/agent_logout?userid=linuxbox&reason=pause

Event AgentStateChange

Agent has changed his state.

Attributes:

userid - agent user ID

state_name - name of changed state

http://server/agent_state_change?userid=linuxbox&state_name=pause