'Prompt Play End' Report

Report the event when the prompt played to the extension and the external number ends.

Report Parameters


Name	Type	Description
`action`	String	Prompt play end.
`callid`	String	A unique identifier of the call.
`prompt`	String	The prompt file name.
`ext`	String	Object parameter.
`extid`	String	Extension number.
`outbound` `inbound`	String	Object parameter.
`trunkname`	String	Trunk name. Note: If playing prompt to an external number, `trunkname` parameter will be used. For other reports, `trunk` parameter will be used.
`trunk`	String	Trunk name.
`ivr`	String	Object parameter.
`ivrid`	String	IVR number.
`playtonum`	String	Play prompt to which number.
`sn`	String	The PBX's serial number.

Report Examples

Play prompt to an extension.

POST / HTTP/1.1
User-Agent: WebAPI

Content-Type: application/json
Accept: application/json

{
    "action": "PlayPromptEnd",
    "callid": "1547395290.362",
    "ext": {
        "extid": "1001"
    },
    "prompt": "record",
    "sn": "369362089179"
}

Play prompt to an external user.

POST / HTTP/1.1
User-Agent: WebAPI


Content-Type: application/json
Accept: application/json

{
    "action": "PlayPromptEnd",
    "callid": "1547395463.366",
    "outbound": {
        "trunkname": "SPS-6-36"
    },
    "prompt": "record",
    "sn": "369362089179"
}

Call an extension via IVR or an extension calls to an IVR, PBX plays a prompt to the extension.

POST / HTTP/1.1
User-Agent: WebAPI


Content-Type: application/json
Accept: application/json

{
    "action": "PlayPromptEnd",
    "callid": "1547395676.370",
    "call": [
        {
            "ext": {
                "extid": "1005"
            }
        }
    ],
    "ivr": {
        "ivrid": "6500"
    },
    "playtonum": "1005",
    "sn": "369362089179"
}

Call an external number via IVR or transfer an outbound call to IVR, PBX plays a prompt to the external number.

POST / HTTP/1.1
User-Agent: WebAPI


Content-Type: application/json
Accept: application/json

{
    "action": "PlayPromptEnd",
    "callid": "1547395803.374",
    "call": [
        {
            "outbound": {
                "trunk": "SPS-6-36"
            }
        }
    ],
    "ivr": {
        "ivrid": "6500"
    },
    "playtonum": "9282837733",
    "sn": "369362089179"
}

Transfer an inbound call to IVR or an inbound call reaches IVR, PBX plays a prompt to the inbound caller number.

POST / HTTP/1.1
User-Agent: WebAPI


Content-Type: application/json
Accept: application/json

{
    "action": "PlayPromptEnd",
    "callid": "1547395941.380",
    "call": [
        {
            "inbound": {
                "trunk": "SPS-6-36"
            }
        }
    ],
    "ivr": {
        "ivrid": "6500"
    },
    "playtonum": "81288833"
    "sn": "369362089179"
}