LinuxBox API

LinuxBox PBX API: PBX Notifications

Built: 2025-06-03 16:34:09

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

dialed_num - dialed number

target_num - target number (same as dialed number, deprecated)

call_id - unique call ID

cel_id - unique event ID

caller_userid - agent ID (only for caller_type internal)

http://server/start_call?caller_type=internal&caller_num=591166223&caller_userid=linuxbox&dialed_num=591166200&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

custom_call_id - custom call identifier

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

Event QueueOut

Call has left the queue.

Attributes:

queue_name - name of the queue

call_id - unique call ID

cel_id - unique event ID

custom_call_id - custom call identifier

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

Event StartIntDial

Start of the call ringtone on internal line.

Attributes:

caller_num - caller number

caller_exten - caller extension

caller_name - caller name

dialed_num - dialed number (only for caller_type external, dialer)

dialed_exten - dialed extension

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

caller_type - caller type (external, originate, dialer)

queue_name - queue name (only for caller_type external)

direction - direction of call (internal, incoming, outgoing)

http://server/start_int_dial?caller_num=591166223&caller_exten=102&caller_name=karel&dialed_num=591166200&dialed_exten=101&line_num=101&line_name=martin&line_userid=linuxbox&custom_call_id=Wua4kaib&call_id=1541078811.98&cel_id=28254912&queue_name=helpdesk&caller_type=external&queue_name=helpdesk&direction=internal

Event StartExtDial

Start of the call ringtone on external line.

Attributes:

caller_num - caller number

caller_exten - caller extension

caller_name - caller name

dialed_num - dialed number

dialed_exten - dialed extension

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

direction - direction of call (internal, incoming, outgoing)

http://server/start_ext_dial?caller_num=591166223&caller_exten=102&caller_name=karel&dialed_num=591166200&dialed_exten=101&line_num=102&line_name=karel&line_userid=linuxbox&custom_call_id=Wua4kaib&call_id=1541078811.98&cel_id=28254912&direction=internal

Event AnsweredInternalCall

The call has been picked up by internal line.

Attributes:

caller_num - caller number

caller_exten - caller extension

caller_name - caller name

dialed_num - dialed number

dialed_exten - dialed extension

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

caller_type - caller type (external, originate, dialer, internal)

direction - direction of call (internal, incoming, outgoing)

http://server/answered_internal?caller_num=591166223&caller_exten=102&caller_name=karel&dialed_num=591166200&dialed_exten=101&line_num=101&line_name=martin&line_userid=linuxbox&custom_call_id=Wua4kaib&call_id=1541078811.98&cel_id=28254912&caller_type=external&direction=internal

Event AnsweredExternalCall

The call has been picked up by remote side.

Attributes:

caller_num - caller number

caller_exten - caller extension

dialed_num - dialed number

dialed_exten - dialed extension

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

direction - direction of call (internal, incoming, outgoing)

http://server/answered_external?caller_num=591166223&caller_exten=102&caller_name=karel&dialed_num=591166200&dialed_exten=101&line_num=102&line_name=karel&line_userid=linuxbox&custom_call_id=Wua4kaib&call_id=1541078811.98&cel_id=28254912&direction=internal

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/pbx_agent_login?userid=linuxbox&exten=121

Event AgentLogout

Agent has been logged out.

Attributes:

userid - agent user ID

reason - logout reason

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

Event AgentSetState

Agent has changed his state.

Attributes:

userid - agent user ID

state_name - name of changed state

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

Event CallSpyStart

Call wiretapping started.

Attributes:

call_id - unique call ID

spying_exten - number initiated the wiretapping

spying_target_exten - wiretapped number

spying_userid - agent user ID initiated the wiretapping

spying_target_userid - wiretapped agent user ID

spy_type - spy type (spy, bargein, whisper)

http://server/call_spy_start?call_id=1541078811.98&spying_exten=101&spying_target_exten=102&spying_userid=linuxbox&spying_target_userid=sales_agent1&spy_type=spy

Event CallSpyEnd

End of call wiretapping.

Attributes:

call_id - unique call ID

spying_exten - number initiated the wiretapping

spying_target_exten - wiretapped number

spying_userid - agent user ID initiated the wiretapping

spying_target_userid - wiretapped agent user ID

spy_type - spy type (spy, bargein, whisper)

http://server/call_spy_end?call_id=1541078811.98&spying_exten=101&spying_target_exten=102&spying_userid=linuxbox&spying_target_userid=sales_agent1&spy_type=spy

Event ExtenPausedUnaswered

Exten paused due unaswered call in queue

Attributes:

call_id - unique call ID

exten - called number

reason - unanswered queue call (unanswered_queue_call)

http://server/exten_paused?call_id=1541078811.98&exten=101&reason=unanswered_queue_call

Event CallRecordingStart

Start of call recording

Attributes:

call_id - unique call ID

http://server/call_recording_start?call_id=1541078811.98

Event CallRecordingStop

Stop of call recording

Attributes:

call_id - unique call ID

http://server/call_recording_stop?call_id=1541078811.98

Event RelatedCallsData

Relations between calls from individual PBXs

Attributes:

call_id - unique identifier for the call

cel_id - unique event ID

data - array of related calls data, each including a pbx_name and a call_id of related call

POST "http://server/related_calls_data" \
                        -H "Content-Type: application/json" \
                        -d '{
                            "call_id": "1541947970.835",
                            "cel_id" : "28254912",
                            "data": [
                                {"call_id": "1541078811.98", "pbx_name": "pbxtest1"},
                                {"call_id": "1554307894.124", "pbx_name": "pbxtest2"}
                            ]
                        }'