'Call Released' Report

The PBX will send two "BYE" reports to the 3rd-party application server when a call is released. In the first "BYE" report, the user who releases the call will appear first.

Report Parameters

Name Type Description
action String Call is released.
callid String A unique identifier of the call.
ext String Extension object.
extid String The extension number.
outbound String Object parameter.
inbound String Object parameter.
inboundid String The inbound ID.
outboundid String The 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

In an internal call between Extension 1005 and Extension 1006; Extension 1006 hangs up the call.
POST / HTTP/1.1
User-Agent: WebAPI
Host: api.yeastarcloud.com
Content-Type: application/json
Accept: application/json

{
    "action": "BYE",
    "callid": "1547375817.78",
    "call": [
        {
            "ext": {
                "extid": "1006"
            }
        },
        {
            "ext": {
                "extid": "1005"
            }
        }
    ],
    "sn": "369362089179"
}

POST / HTTP/1.1
User-Agent: WebAPI

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

{
    "action": "BYE",
    "callid": "1547375817.78",
    "call": [
        {
            "ext": {
                "extid": "1005"
            }
        },
        {
            "ext": {
                "extid": "1006"
            }
        }
    ],
    "sn": "369362089179"
}
In an outbound call between Extension 1005 and external number 12564555; external user 12564555 hangs up the call.
POST / HTTP/1.1
User-Agent: WebAPI

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

{
    "action": "BYE",
    "callid": "1547376084.84",
    "call": [
        {
            "outbound": {
                "from": "1005",
                "to": "12564555 ",
                "trunk": "SPS-6-36",
                "outboundid": "1547376084.85"
            }
        },
        {
            "ext": {
                "extid": "1005"
            }
        }
    ],
    "sn": "369362089179"
}

POST / HTTP/1.1
User-Agent: WebAPI

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

{
    "action": "BYE",
    "callid": "1547376084.84",
    "call": [
        {
            "ext": {
                "extid": "1005"
            }
        },
        {
            "outbound": {
                "from": "1005",
                "to": "12564555",
                "trunk": "SPS-6-36",
                "outboundid": "1547376084.85"
            }
        }
    ],
    "sn": "369362089179"
}