CallStatus

The PBX will send the status information of all calls to the application server in real time.

Note: If you want to monitor the call status on a specified trunk, enable Status Monitor for Trunk on PBX API web interface

Report parameters

Parameter Type Description
event String Event type.
callid String The unique ID of each call.
members Array <MemberType> A list of information for different types of members during a call.
sn String The PBX's serial number.
MemberType
Parameter Type Description
ext Object <ExtensionInfo> Extension information.
inbound Object <InboundInfo> The information of inbound calls.
outbound Object <OutboundInfo> The information of outbound calls.
ExtensionInfo
Parameter Type Description
number String The extension number.
channelid String The call channel ID of each member during the call.
memberstatus String The member status.
  • ALERT: The caller who initiates the call is in the ringback state.
  • RING: The callee is in the ringing state.
  • ANSWERED: The call initiated by the caller has been answered.
  • ANSWER: The callee has answered a call, and is in the talking state.
  • HOLD: The call is held.
  • BYE: The call is hanged up.
callpath Integer The call path that indicates how the call is established.
Note: callpath parameter only appears when the call passes through IVR, Queue, Ring Group, Paging/Intercom or Conference.

For example, extension user 1000 calls to IVR (6500), and dials extension number 2000, the callpath value is 6500.
InboundInfo
Parameter Type Description
from Integer The caller number.
to Integer The callee number.
trunkname String The name of the trunk that passes the inbound calls.
channelid String The call channel ID of each member during the call.
memberstatus String The member status.
  • ALERT: The caller who initiates the call is in the ringback state.
  • RING: The callee is in the ringing state.
  • ANSWERED: The call initiated by the caller has been answered.
  • ANSWER: The callee has answered a call, and is in the talking state.
  • HOLD: The call is held.
  • BYE: The call is hanged up.
callpath Integer
The call path that indicates how the call is established.
Note: callpath parameter only appears when the call passes through trunk, IVR, Queue, Ring Group, Paging/Intercom or Conference.
For example, external user 5503302 calls to IVR (6500), and dials extension number 2000, the callpath value is 6500.
OutboundInfo
Parameter Type Description
from Integer The caller number.
to Integer The callee number.
trunkname String The name of the trunk that passes the outbound calls.
channelid String The call channel ID of each member during the call.
memberstatus String The member status.
  • ALERT: The caller who initiates the call is in the ringback state.
  • RING: The callee is in the ringing state.
  • ANSWERED: The call initiated by the caller has been answered.
  • ANSWER: The callee has answered a call, and is in the talking state.
  • HOLD: The call is held.
  • BYE: The call is hanged up.
callpath Integer
The call path that indicates how the call is established.
Note: callpath parameter only appears when the call passes through IVR, Queue, Ring Group or Conference.

For example, make a call from IVR 6500 to external number 5503302, the callpath value is 6500.

Report example

POST / HTTP/1.1
Host: 192.168.5.150: 8260
Accept: application/json
User-Agent: WebAPI
Content-Type: application/json
Accept: application/json

{
	"event": "CallStatus",
	"callid": "1571887584.74",
	"members": [
		{
			"inbound": {
				"from": "2000",
				"to": "1023",
				"trunkname": "siptrunk",
				"channelid": "PJSIP/trunk-siptrunk-endpoint-00000030",
				"memberstatus": "ALERT"
			}
		},
		{
			"ext": {
				"number": "1023",
				"channelid": "PJSIP/1023-00000031",
				"memberstatus": "RING"
			}
		}
	],
	"sn": "369451090405"
}