extension_events. Below, are the various message keys.
extension_register: extension registered to the PBX or un-register from the PBX.
extensionis indicates which extension occurs the register event, the
extension_idis the id of that extension. The array
registration_contactsis includes the current registrations information. In this example, there have two SIP client devices/apps are registered to PBX, their agents are:
Test SIPMaster for IOSand
PortSIP UC Client iOS - v16.0.001, if both of these clients are unregistered from PBX, the array "
registration_contacts" will not presents, see below example:
registration_contactsis no longer present, but have an array is
removed_contactsindicates which client app/device is unregistered from PBX, in case, the client App
PortSIP UC Client iOS - v16.0.001is unregistered from PBX, now there are no any registrations on the PBX so the extension 102 is offline.
call_hold: call was held.
call_holdevent will occur, see below example:
call_unhold: call has been resumed from hold.
call_start: call starting.
extmeans the call is between extensions. the
session_idis a unique ID of this call, after call is completed, we can use this session_id to query the recording file by REST API.
call_established: the call was answered and successfully connected.
call_ended: call has ended.
call_noanswer: call is a no answer in the specified time(seconds) then hang up due to timeout.
call_reroute: the call was re-routed to another target.
call_fail: call has failed.
fail_codeis 480 which is the same as the status code of the SIP standards.
target_add: start a call to a target. For example, extension 101 is registered to PBX from an IP Phone or an App, when someone makes calls to 101, the IP Phone, or App will be added as the target. (The target_add event will be triggered two times.)
target_ringing: the called target is ringing.
target_noanswer: there is no answer from the called target.
target_fail: call failed from the called target. For example, the App / IP Phone rejected the call.
target_ended: call has ended from the called target. For example, the App / IP Phone hangs up the call.
cdr_events, the message key is below.
call_cdr: once a call has ended, the CDR will be packed in JSON format and pushed to the subscriber.
queue_status: if the queue status changed, the information will be packed into a JSON message and pushed to the subscriber.
queue_member_state: if the agent of the queue state is set to ready or not-ready, this message will be pushed.
trunk_connected: PBX is successfully connected to a trunk.
trunk_disconnected: PBX is successfully connected to a trunk.
domainis the SIP domain of the extension, the
web passwordof extension.