(30017) DTMF

If a user enters DTMF digits during a call, the PBX will send an events report to the third-party application.

Report parameters

Parameter Type Description
type Integer Event ID.
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.
info String A DTMF character.
flag Integer The sequence of DTMF.
Note: flag starts from digit 0. 0 indicates the first DTMF; 1 indicates the second DTMF, and so forth.
infos String A DTMF string.
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

External number 13900000002 dials in an IVR, and dials digit 1.
{
    "type": 30017,
    "sn": "3631A2124XXX",
    "msg": "{
       "call_id":"1648865408.348",
       "members":[
          {
             "inbound":{
                 "from":"13900000002",
                 "to":"2002",
                 "trunk_name":"peer-to-41",
                 "channel_id":"PJSIP/trunk-peer-to-41-endpoint-000000e0",
                 "member_status":"ALERT",
                 "call_path":" "
                           }
            }
                   ],
          "info":"1",
          "flag":0,
          "infos":" "

             }"
}