'Ringing' & 'Ring Back' Report

Note:

The extension status monitoring must be enabled on the PBX API configuration interface before the PBX will send the ring report and ring back report.
In the same call event, the PBX sends a ring report and a ring back report at the same time.

Report Parameters - Ring Back

After the caller dials the called number and the callee rings, the caller hears the ring back tone.

Name	Type	Description

Name	Type	Description
`action`	String	Ringback event: ALERT.
`callid`	String	A unique identifier of the call.
`call`	Object	Object parameters.
Caller is extension
`ext`	Object	Extension object.
`extid`	String	The extension number (caller).
Caller is an outside number
`inbound`	Object	External call object.
`from`	String	The caller number.
`to`	String	The callee number.
`trunk`	String	The name of the trunk that has been used.
`inboundid`	String	Outside caller ID.
`sn`	String	The PBX's serial number.

Report Parameters - Ringing

After the called party receives the call, the called party hears a ringing tone.

Note: The called number and calling number will be displayed in the ring report event. In the report, the called number is displayed first, and then the calling number.

Name	Type	Description

Name	Type	Description
`action`	String	Ring back event: RING.
`callid`	String	A unique identifier of the call.
`call`	Object	Object parameters.
The caller is an extension and the callee is an extension
`ext`	Object	extension object.
`extid`	String	The extension number (caller).
The caller is an extension and the callee is an external number. The outbound object is displayed first, and then the ext object is displayed.
`outbound`	String	Outgoing call object.
`from`	String	The caller number.
`to`	String	The callee number.
`trunk`	String	The trunk that is used to call out.
`outboundid`	String	Outside callee ID.
The caller is an external number, and the callee is an extension. The ext object is displayed first, and then the inbound object is displayed.
`inbound`	String	External call object.
`from`	String	The caller number.
`to`	String	The callee number.
`trunk`	String	The trunk that is used to call out.
`inboundid`	String	Outside caller ID.
`sn`	String	The PBX's serial number.

Report Examples

Extension 101 calls to extension 106.

POST  HTTP/1.1
Host:172.16.6.150
Content-Length:89
Accept: application/json
Content-Type:application/json
Connection:close
{
    "action":"ALERT",
    "callid":"1589947952.1670",
    "ext":{
        "extid":[
            "101"
        ]
    },
    "sn":"a09805021987"
}
 
POST  HTTP/1.1
Host:172.16.6.150
Content-Length:94
Accept: application/json
Content-Type:application/json
Connection:close
{
    "action":"RING",
    "callid":"1589947952.1670",
    "ext":{
        "extid":["106","101"]
    },
    "sn":"a09805021987"
}

Extension 106 calls to external number 16103.

POST  HTTP/1.1
Host:172.16.6.150
Content-Length:67
Accept: application/json
Content-Type:application/json
Connection:close
 
{
    "action":"ALERT",
    "callid":"1589948179.1692",
    "ext":{
        "extid":"106"
    }
}
 
POST  HTTP/1.1
Host:172.16.6.150
Content-Length:155
Accept: application/json
Content-Type:application/json
Connection:close
 
{
    "action":"RING",
    "callid":"1589948178.1690",
    "outbound":{
        "from":"106",
        "to":"103",
        "trunk":"to-18-16-2",
        "outboundid":"1589948178.1690"
    },
    "ext":{
        "extid":"106"
    }
}

The external number 103 calls extension 101.

POST  HTTP/1.1
Host:172.16.6.150
Content-Length:152
Accept: application/json
Content-Type:application/json
Connection:close
 
{
    "action":"ALERT",
    "callid":"1589948512.1709",
    "inbound":{
        "from":"103",
        "to":"101",
        "trunk":"to-18-16-2",
        "inboundid":"1589948512.1707"
    },
    "sn":"a09805021987"
}
 
POST  HTTP/1.1
Host:172.16.6.150
Content-Length:173
Accept: application/json
Content-Type:application/json
Connection:close
 
{
    "action":"RING",
    "callid":"1589948512.1709",
    "ext":{
        "extid":"101"
    },
    "inbound":{
        "from":"103",
        "to":"101",
        "trunk":"to-18-16-2",
        "inboundid":"1589948512.1707"
    },
    "sn":"a09805021987"
}