'Ringing' Report

The PBX will send a report to the application server when an extension is ringing. But only when the ringing is triggered by a dial using the API, the report will be sent, namely, if a ringing is triggered by a dial made from an extension, the report will not be sent.

Ringing (the called party) and ring back (the calling party) coexist. Calls with external numbers and internal calls will both be reported. In the report, the calling party's number will appear first.

Report Parameters

Name Type Description
action String Ringing.
callid String A unique identifier of the call.
ext String Extension object.
extid String The extension number.
inbound

outbound

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.
sn String The PBX's serial number.

Report Examples

Extension 1001 calls to extension 1002.

POST / HTTP/1.1
User-Agent: WebAPI
Host: api.yeastarcloud.com
Content-Type: application/json
Accept: application/json

{
    "action": "ALERT",
    "callid": "1550710849.199",
    "call": [
        {
            "ext": {
                "extid": "1001"
            }
        }
    ],
    "sn": "369351034049"
}
POST / HTTP/1.1
User-Agent: WebAPI

Host: api.yeastarcloud.com
Content-Type: application/json
Accept: application/json
{
    "action": "RING",
    "callid": "1550710849.199",
    "call": [
        {
            "ext": {
                "extid": "1002"
            }
        },
        {
            "ext": {
                "extid": "1001"
            }
        }
    ],
    "sn": "369351034049"
}
Extension 1001 calls to external number 9282883883.
POST / HTTP/1.1
User-Agent: WebAPI

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

{
    "action": "ALERT",
    "callid": "1547396927.428",
    "call": [
        {
            "ext": {
                "extid": "1001"
            }
        }
    ],
    "sn": "369362089179"
}

POST / HTTP/1.1
User-Agent: WebAPI

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

{
    "action": "RING",
    "callid": "1547396927.428",
    "call": [
        {
            "outbound": {
                "from": "1001",
                "to": "9282883883",
                "trunk": "SPS-6-36",
                "outboundid": "1547396927.429"
            }
        },
        {
            "ext": {
                "extid": "1001"
            }
        }
    ],
    "sn": "369362089179"
}