博域通讯IP呼叫中心系统BYIPCC1.2中的IVR流程服务软件中的事件和API命令介绍

博域通讯IP呼叫中心系统BYIPCC1.2中的IVR流程服务软件中的事件和API命令介绍当IP呼叫中心系统BYIPCC1.2启动、配置变更、分机状态变更或呼叫状态变更等发生时，IP呼叫中心系统BYIPCC1.2会自动触发相应的事件，当应用服务器开启了监听端口，则可以监听到这些事件。IP呼叫中心系统BYIPCC1.2中的IVR流程服务软件的源代码，博域通讯开放给第三方软件开发商(合作伙伴以及最终用户)。IVR流程服务软件的二次开发工作为在博域通讯IP呼叫中心平台产品BYIPCC1.2内置的图形化IVR流程编辑器与脚本一体化的IVR（交互式语音服务)流程开发环境中对交互式语音服务IVR模板流程的简单修改。一、系统启动事件(BOOTUP)当IP呼叫中心系统BYIPCC1.2启动完成后，IP呼叫中心系统BYIPCC1.2会向IVR流程服务软件推送该报告。报告示例<?xml version="1.0" encoding="utf-8" ?><Event attribute="BOOTUP"></Event>二、来电呼入事件(INCOMING)在中继的“来电应答后控制”开关打开的情况下，当来电呼叫该中继时，IP呼叫中心系统BYIPCC1.2会在应答该来电后，向IVR流程服务软件推送INCOMING事件。报告示例<?xml version="1.0" encoding="utf-8" ?><Event attribute="INCOMING"> <trunk id="02161203000" /> <visitor id="31" from="13012345678" to="02261204000" callid="36895" /></Event>三、按键信息事件(DTMF)该事件用于汇报用户输入的按键信息。呼叫（来电/去电/分机）转接到语音菜单（menu）后，用户按键且按键信息满足menu的配置条件时，IP呼叫中心系统BYIPCC1.2向IVR流程服务软件推送该事件。说明：通过IP呼叫中心系统BYIPCC1.2 的web页面配置的多级语音导航（IVR）按键时不会上报DTMF事件，而功能键*66、*67的绑定解绑按键会上报DTMF事件。报告示例<?xml version="1.0" encoding="utf-8" ?><Event attribute="DTMF"> <visitor id="4" from="13012345678" to="02263208234" callid="36868"> <info>12345</info> <menu id="1" /> </visitor></Event>报告包体参数参数名称参数说明<visitor | outer>来去电<id>来去电的编号，可依据该参数进行呼叫转接<from>主叫号码<to>被叫号码<callid>该路通话的相对唯一的编号trunk本路呼叫通过的中继线号码<info>用户按键信息menu来去电呼叫驻留的语音菜单更多示例情况一：来电接通到语音菜单中，用户拨号长度达到该菜单的拨号检测长度时，IP呼叫中心系统BYIPCC1.2就会向应用服务器推送该报告。（菜单1的拨号检测长度为5，按键检查结束符为 #，用户输入12345）<?xml version="1.0" encoding="utf-8" ?><Event attribute="DTMF"> <visitor id="4" from="13012345678" to="02263208234" callid="36868"> <info>12345</info> <menu id="1" /> </visitor></Event>情况二：来电接通到语音菜单中，用户输入了该菜单的按键检查结束符时，IP呼叫中心系统BYIPCC1.2就会向应用服务器推送该报告（菜单1的拨号检测长度为5，按键检查结束符为 #，用户输入200#）。<?xml version="1.0" encoding="utf-8" ?><Event attribute="DTMF"> <visitor id="4" from="13012345678" to="02263208234" callid="36868"> <info>200#</info> <menu id="1" /> </visitor></Event>情况三：去电接通到语音菜单中，用户拨号长度达到该菜单的拨号检测长度时，IP呼叫中心系统BYIPCC1.2就会向应用服务器推送该报告。（菜单1的拨号检测长度为5，按键检查结束符为 #，用户输入12345）<?xml version="1.0" encoding="utf-8" ?><Event attribute="DTMF"> <outer id="4" from="200" to="13012345678" callid="68671" trunk="02263208234"> <info>12345</info> <menu id="1" /> </outer></Event>四、语音文件播放完毕事件(EndOfAnn)呼叫转接到语音菜单（menu）后，IP呼叫中心系统BYIPCC1.2播放menu的语音文件(voicefile)，当语音文件按照指定播放次数播放完毕后，IP呼叫中心系统BYIPCC1.2向应用服务器推送该事件。注：语音播放过程中，若用户按键，语音停止播放，则IP呼叫中心系统BYIPCC1.2不推送EndOfAnn事件。报告示例来电转menu：<?xml version="1.0" encoding="utf-8" ?><Event attribute="EndOfAnn"> <visitor id="67" from="13012345678" to="208" callid="32835" /> <menu id="1" /></Event>去电转menu：<?xml version="1.0" encoding="utf-8" ?><Event attribute="EndOfAnn"> <outer id="4" from="200" to="13012345678" callid="68671" trunk="02263208234" /> <menu id="1" /></Event>分机转menu：<?xml version="1.0" encoding="utf-8" ?><Event attribute="EndOfAnn"> <ext id="200" /> <menu id="1" /></Event>报告包体参数参数名称参数说明<visitor | outer>来去电<id>来去电的编号，可依据该参数进行呼叫转接<from>主叫号码<to>被叫号码<callid>该路通话的相对唯一的编号trunk本路呼叫通过的中继线号码<info>用户按键信息（暂时无用）<menu id>语音菜单博域通讯IP呼叫中心平台产品BYIPCC1.2的交互式语音应答(IVR)软件BYIPCCIVR1.2的模板程序源代码【事件】的部分截图如下：五 配置(Assign)命令此类API用于对IPPBX的对象进行参数配置。对象包括：语音菜单（menu）、分机（ext）、分机组(group)。配置请求的规则说明 分机的配置说明：分机的各个配置参数之间是相互独立，即，配置命令中如果没有携带某参数，则该参数保持原值不变； 其他对象的配置说明：除了分机，其他对象的配置参数都是非独立的，即，如果配置命令中没有携带某参数，则该参数值有可能被清空或还原默认值； 特别注意：API配置不会写配置文件，而是缓存在内存，设备重启会丢失，所以应用服务器应该保留做过的相关配置，当收到设备的重启事件（BOOTUP）时，将保留的配置重新下发一次。配置结果的规则说明 如果参数值为默认值或空时，响应结果中可能不携带该参数； 如果配置参数不生效时，响应结果中也可能不携带该参数； 除此之外，配置结果中将尽可能包含所有可提供的相关参数和状态信息等。5.1配置分机该API用于对指定线路号的分机进行参数配置，并返回配置后的结果及状态。配置参数包括：分机号、呼叫状态方式、呼叫权限、免打扰、代接权限等。请求示例<?xml version="1.0" encoding="utf-8" ?><Control attribute="Assign"> <ext lineid="IPPhone 50"> <id>208</id> <staffid>1304081</staffid> <mobile>18603752800</mobile> <group>1</group> <group>2</group> <voicefile>busy</voicefile> <email>admin</email> <Call_Restriction>3</Call_Restriction> <Call_Pickup>no</Call_Pickup> <No_Disturb>no</No_Disturb> <Fwd_Type>0</Fwd_Type> <Fwd_Number>18603752801</Fwd_Number> <Fork>18603752802</Fork> <WAKEUP>06:30</WAKEUP> <record>on</record> <autoAnswer>yes </autoAnswer> <api>7</api> </ext></Control>参数说明说明：<>表示必选项，表示可选项，（当参数值为默认值或空时，响应消息可能不携带该参数），| 表示或者关系参数名称类型参数说明参数值说明<ext lineid>string分机的线路编号注：通过查询设备信息可获取线路编号<Phone | IPPhone> number,如Phone 1idstring分机号码纯数字非空字符串staffidstring工号，分机接通前会向来电方播放该工号纯数字字符串，值为空时不生效groupint分机所属的分机组，同一分机可属多个分机组。注：若配置分机时未携带group信息，则分机将从该分机组中被清除。150voicefilestring语音文件，这里为分机队列中排队等待时播放的语音文件只支持.dat和.pcm格式emailstring员工的电子邮件地址（暂无对应功能）服从标准邮箱格式