PlayPromptEnd(语音播放结束事件)

PBX 向分机号码或外线号码播放音乐结束后,会向应用服务器推送 PlayPromptEnd 报告。

报告参数

语音播放结束包括两种类型:IVR 语音播放结束、指定语音文件播放结束。
指定语音播放结束
参数 类型 描述
event String 事件类型。
callid String 每个通话的唯一 ID。
members Array <MemberType> 通话中的不同类型成员的信息列表。
prompt String 播放的语音文件名称。
sn String PBX 的 SN 码。
IVR 语音播放结束
参数 类型 描述
event String 事件类型。
callid String 每个通话的唯一 ID。
members Array <MemberType> 通话中的不同类型成员的信息列表。
ivr Object <IVRInfo> IVR 提示音对象。
sn String PBX 的 SN 码。
MemberType
参数 类型 描述
ext Object <ExtensionInfo> 分机的信息。
inbound Object <InboundInfo> 外线来电的信息。
outbound Object <OutboundInfo> 外线呼出的信息。
ExtensionInfo
参数 类型 描述
number String 分机号码。
channelid String 通话中,每个成员的通话通道 ID。
callpath Integer 通话建立使用的路径。

例如,IVR (6500)语言播放结束后,callpath 即为 6500。

InboundInfo
参数 类型 描述
from Integer 主叫号码。
to Integer 被叫号码。
trunkname String 通过哪条中继呼入。
channelid String 通话中,每个成员的通话通道 ID。
callpath Integer 通话建立使用的路径。

例如,IVR (6500)语言播放结束后,callpath 即为 6500。

OutboundInfo
参数 类型 描述
from Integer 主叫号码。
to Integer 被叫号码。
trunkname String 从哪条中继呼出。
channelid String 通话中,每个成员的通话通道 ID。
callpath Integer 通话建立使用的路径。

例如,IVR (6500)语言播放结束后,callpath 即为 6500。

IVRInfo
参数 类型 描述
number String IVR 号码。

示例 1

面向广播组成员播放语音结束后,PBX 向应用服务器推送的报告。

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"
}

示例 2

面向外线播放语音结束后,PBX 向应用服务器推送的报告。
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"
}

示例 3

面向分机播放 IVR 提示音,播放结束后,PBX 向应用服务器推送的报告。
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"
}

示例 4

面向外线呼入后播放 IVR 提示音,播放结束后,PBX 向应用服务器推送的报告。

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"
}

示例 5

使用 IVR 呼出外线,提示音播放结束后,PBX 向应用服务器推送的报告。
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":"6501"
			}
		}
	],
	"ivr": {
		"number": "6501"
	},
	"sn": "369451090405"
}