'Keypress' Report

This event is used report key pressed (DTMF information) during a call.

For example, when a call reaches IVR, and the IVR's keypress event is triggered, the PBX will send the event to the application server.

Report Parameters

Name Type Description
action String DTMF event.
callid String A unique identifier of the call.
ext Object Extension Object.
extid String Extension number(caller).
info String Single DTMF value.
outbound

inbound

 String Object parameter.
inboundid

outboundid

 String The inbound ID / outbound ID.
from String The caller number.
to String The callee number.
trunk String The name of the trunk that has been used.
flag Int The sequence of DTMF.
Note: flag starts from digit 0. 0 indicates that the DTMF is the first one; 1 indicates that the DTMF is the second one; and so on.
infos String DTMF String.
sn String The PBX's serial number.

Report Examples

Extension 1005 dials in an IVR, then dials digit 2.

POST / HTTP/1.1
User-Agent: WebAPI
Host: api.yeastarcloud.com
Content-Type: application/json
Accept: application/json
{
    "action": "DTMF",
    "callid": "1547389829.281",
    "call": [
        {
            "ext": {
                "extid": "1005"
            }
        }
    ],
    "info": "2",
    "flag": "0",
    "sn": "369362089179"
}

External user 192883838 calls to IVR 6500, then dials extension number 1005.

POST / HTTP/1.1
User-Agent: WebAPI

Host: api.yeastarcloud.com
Content-Type: application/json
Accept: application/json
{
    "action": "DTMF",
    "callid": "1547391097.305",
    "call": [
        {
            "inbound": {
                "from": "192883838",
                "to": "6500",
                "trunk": "SPS-6-36",
                "inboundid": "1547391097.305"
            }
        }
    ],
    "info": "1",
    "flag": "0",
    "sn": "369362089179"
}

POST / HTTP/1.1
User-Agent: WebAPI

Host: api.yeastarcloud.com
Content-Type: application/json
Accept: application/json
{
    "action": "DTMF",
    "callid": "1547391097.305",
    "call": [
        {
            "inbound": {
                "from": "192883838",
                "to": "6500",
                "trunk": "SPS-6-36",
                "inboundid": "1547391097.305"
            }
        }
    ],
    "info": "0",
    "flag": "1",
    "sn": "369362089179"
}

POST / HTTP/1.1
User-Agent: WebAPI

Host: api.yeastarcloud.com
Content-Type: application/json
Accept: application/json
{
    "action": "DTMF",
    "callid": "1547391097.305",
    "call": [
        {
            "inbound": {
                "from": "192883838",
                "to": "6500",
                "trunk": "SPS-6-36",
                "inboundid": "1547391097.305"
            }
        }
    ],
    "info": "0",
    "flag": "2",
    "sn": "369362089179"
}

POST / HTTP/1.1
User-Agent: WebAPI

Host: api.yeastarcloud.com
Content-Type: application/json
Accept: application/json

{
    "action": "DTMF",
    "callid": "1547391097.305",
    "call": [
        {
            "inbound": {
                "from": "192883838",
                "to": "6500",
                "trunk": "SPS-6-36",
                "inboundid": "1547391097.305"
            }
        }
    ],
    "info": "5",
    "flag": "3",
    "sn": "369362089179"
}

POST / HTTP/1.1
User-Agent: WebAPI

Host: api.yeastarcloud.com
Content-Type: application/json
Accept: application/json

{
    "action": "DTMF",
    "callid": "1547391097.305",
    "call": [
        {
            "inbound": {
                "from": "192883838",
                "to": "6500",
                "trunk": "SPS-6-36",
                "inboundid": "1547391097.305"
            }
        }
    ],
    "infos": "1005",
    "sn": "369362089179"
}

Extension 1005 dials an external number to enter an external IVR, then dials digit 1.

POST / HTTP/1.1
User-Agent: WebAPI

Host: api.yeastarcloud.com
Content-Type: application/json
Accept: application/json

{
    "action": "DTMF",
    "callid": "1547391490.309",
    "call": [
        {
            "ext": {
                "extid": "1005"
            }
        }
    ],
    "info": "1",
    "flag": "0",
    "sn": "369362089179"
}