'Call Transfer' Report

When there is a call transferred inside the PBX, the PBX will send a report to the application server.

Note:
  • The report only includes operations performed by the extensions, such as dialing "*03" and "*3" feature codes or Call Forwarding settings.
  • Transfer controlled by API will not be reported.

Report Parameters

Name Type Description
action String Call is transferred.
callid String A unique identifier of the call.
ext String extension object.
extid String The extension number of the extension that initiates the transfer.
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.
sn String The PBX's serial number.

Report Examples

In the internal call between Extension 1005 and Extension 1001, Extension 1005 transfers the call to another number.

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

{
    "action": "Tranfer",
    "callid": "1547378727.152",
    "call": [
        {
            "ext": {
                "extid": "1005"
            }
        },
        {
            "ext": {
                "extid": "1001"
            }
        }
    ],
    "sn": "369362089179"
}

On Extension 1001, configure Call Forwarding to number A. When Extension 1006 calls to Extension 1001, the call is forwarded.

POST / HTTP/1.1
User-Agent: WebAPI

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

{
    "action": "Tranfer",
    "callid": "1547379044.160",
    "call": [
        {
            "ext": {
                "extid": "1006"
            }
        }
    ],
    "sn": "369362089179"
}

In the inbound call between external number 182837733 and Extension 1001, Extension 1001 transfers the call to another number. 

POST / HTTP/1.1
User-Agent: WebAPI

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

{
    "action": "Tranfer",
    "callid": "1547379694.192",
    "call": [
        {
            "inbound": {
                "from": "182837733",
                "to": "1001",
                "trunk": "SPS-6-36",
                "inboundid": "1547379694.192"
            }
        }
    ],
    "sn": "369362089179"
}