PlayPromptEnd

After the audio prompt ends, the PBX will send a PlayPromptEnd report to the application server.

Report parameters

The specified audio played ends
Parameter Type Description
event String Event type.
callid String The unique ID of each call.
members Array <MemberType> A list of information for different types of members during a call.
prompt String File name of the audio prompt to be played.
sn String The PBX's serial number.
IVR audio played ends
Parameter Type Description
event String Event type.
callid String The unique ID of each call.
members Array <MemberType> A list of information for different types of members during a call.
ivr Object <IVRInfo> IVR information.
sn String The PBX's serial number.
MemberType
Parameter Type Description
ext Object <ExtensionInfo> Extension information.
inbound Object <InboundInfo> The information of inbound calls.
outbound Object <OutboundInfo> The information of outbound calls.
ExtensionInfo
Parameter Type Description
number String The extension number.
channelid String The call channel ID of each member during the call.
callpath Integer The call path that indicates how the call is established.

For example, IVR (6500) audio prompt ends, callpath value is 6500.
InboundInfo
Parameter Type Description
from Integer The caller number.
to Integer The callee number.
trunkname String The name of the trunk that passes the inbound calls.
channelid String The call channel ID of each member during the call.
callpath Integer The call path that indicates how the call is established.

For example, IVP (6500) audio prompt ends, callpath value is 6500.
OutboundInfo
Parameter Type Description
from Integer The caller number.
to Integer The callee number.
trunkname String The name of the trunk that passes the outbound calls.
channelid String The call channel ID of each member during the call.
callpath Integer The call path that indicates how the call is established.

For example, IVR (6500) audio prompt ends, callpath value is 6500.
IVRInfo
Parameter Type Description
number String The IVR number.

Report example 1

Play audio prompt to members in a Paging Group.

POST / HTTP/1.1
Host: 192.168.5.150: 8260
Accept: application/json
User-Agent: WebAPI
Content-Type: application/json
Accept: application/json

{
	"event": "PlayPromptEnd",
	"callid": "1571965641.241",
	"members": [
		{
			"ext": {
				"number": "2023",
				"channelid": "PJSIP/2023-0000008f"
			}
		},
		{
			"ext": {
				"number": "1023",
				"channelid": "PJSIP/1023-00000090"
			}
		}
	],
	"prompt": "music1",
	"sn": "369451090405"
}

Report example 2

Play audio prompt to an external number after the outbound call is answered.
POST / HTTP/1.1
Host: 192.168.5.150: 8260
Accept: application/json
User-Agent: WebAPI
Content-Type: application/json
Accept: application/json

{
	"event": "PlayPromptEnd",
	"callid": "1571909302.194",
	"members": [
		{
			"outbound": {
				"from": "prompt",
				"to": "2000",
				"trunkname": "siptrunk",
				"channelid": "PJSIP/trunk-siptrunk-endpoint-00000074"
			}
		}
	],
	"prompt": "music1",
	"sn": "369451090405"
}

Report example 3

Play IVR prompt to an extension after the extension dials in IVR.
POST / HTTP/1.1
Host: 192.168.5.150: 8260
Accept: application/json
User-Agent: WebAPI
Content-Type: application/json
Accept: application/json

{
	"event": "PlayPromptEnd",
	"callid": "1571910100.203",
	"members": [
		{
			"ext": {
				"number": "1023",
				"channelid": "PJSIP/1023-00000079",
                            "callpath":"6500"
			}
		}
	],
	"ivr": {
		"number": "6500"
	},
	"sn": "369451090405"
}

Report example 4

Play IVR prompt to an external number after the inbound call is answered.

POST / HTTP/1.1
Host: 192.168.5.150: 8260
Accept: application/json
User-Agent: WebAPI
Content-Type: application/json
Accept: application/json

{
	"event": "PlayPromptEnd",
	"callid": "1571910690.206",
	"members": [
		{
			"inbound": {
				"from": "2000",
				"to": "6500",
				"trunkname": "siptrunk",
				"channelid": "PJSIP/trunk-siptrunk-endpoint-0000007b",
                            "callpath":"6500"
			}
		}
	],
	"ivr": {
		"number": "6500"
	},
	"sn": "369451090405"
}

Report example 5

Place an outbound call via IVR, and play IVR prompt to the external number.
POST / HTTP/1.1
Host: 192.168.5.150: 8260Host: api.yeastarcloud.com
Accept: application/json
User-Agent: WebAPI
Content-Type: application/json
Accept: application/json

{
	"event": "PlayPromptEnd",
	"callid": "1571979960.74",
	"members": [
		{
			"outbound": {
				"from": "6501",
				"to": "2100",
				"trunkname": "siptrunk",
				"channelid": "PJSIP/trunk-siptrunk-endpoint-00000014",
                            "callpath":"6500"
			}
		}
	],
	"ivr": {
		"number": "6501"
	},
	"sn": "369451090405"
}