(30014) Call Forward

If Call Forwarding is enabled for an extension, when an incoming call to the extension is forwarded, the PBX will send an event report to the third-party application.

Report parameters

Parameter Type Description
sn String PBX's serial number.
msg Object<Call_Info> The detailed information of the calls.
Call_Info
Parameter Type Description
call_id String The unique ID of each call.
members Array<Members> A list of information for different types of members during the call.
Members
Table 1.
Parameter Type Description
extension Object<Extension_Info> The information of the extensions.
inbound Object<Inbound_Info> The information of the inbound calls.
outbound Object<Outbound_Info> The information of the outbound calls.
Extension_Info
Table 2.
Parameter Type Description
number String Extension number.
channel_id String The call channel ID of each member during the call.
member_status String The current call status of the member.
  • ALERT: The caller who initiate 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 the call, and is in the talking state.
  • HOLD: The call is held.
  • BYE: The call is hung up.
call_path String The call path that indicates how the call is established.
Note: This parameter returns the call path when the call passes through IVR, Queue, Ring Group, Paging/Intercom or Conference.
Inbound_Info
Table 3.
Parameter Type Description
from String The caller number.
to String The callee number.
trunk_name String The name of the trunk that passes the inbound call.
channel_id String The call channel ID of each member during the call.
member_status String The current call status of the member.
  • ALERT: The caller who initiate 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 the call, and is in the talking state.
  • HOLD: The call is held.
  • BYE: The call is hung up.
call_path String The call path that indicates how the call is established.
Note: This parameter returns the call path when the call passes through IVR, Queue, Ring Group, Paging/Intercom or Conference.
Outbound_Info
Table 4.
Parameter Type Description
from String The caller number.
to String The callee number.
trunk_name String The name of the trunk that passes the outbound call.
channel_id String The call channel ID of each member during the call.
member_status String The current call status of the member.
  • ALERT: The caller who initiate 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 the call, and is in the talking state.
  • HOLD: The call is held.
  • BYE: The call is hung up.
call_path String The call path that indicates how the call is established.
Note: This parameter returns the call path when the call passes through IVR, Queue, Ring Group, Paging/Intercom or Conference.

Report example

Extension 2000 calls extension 2002, and the call is forwarded to another number.

{
    "type": 30014,
    "sn": "3631A2124XXX",
    "msg": "{
        "call_id":"1650080643.447",
        "members":[
           {
              "extension":{
                     "number":"2000",
                     "channel_id":"PJSIP/2000-000000e0",
                     "member_status":"ALERT",
                     "call_path":" "
                              }
             }
                     ]
              }"
}
External number 5503301 calls extension 2002, and the call is forwarded to another number.
{
    "type": 30014,
    "sn": "3631A2124XXX",
    "msg": "{
            "call_id":"1650080369.440",
            "members":[
               {
                  "inbound":{
                      "from":"5503301",
                      "to":"2002",
                      "trunk_name":"test-peer-trunking",
                      "channel_id":"PJSIP/trunk-test-peer-trunking-endpoint-000000dd",
                      "member_status":"ALERT",
                      "call_path":" "
                              }
                }
                       ]
            }"
}