OMAPI帮助文档.doc

上海迅时通信设备有限公司OM系列IPPBXAPI 帮助手册 修改记录文档版本 02 (2005-12-16 修改人：xxx)第一次修改。文档内容更新如下：第3章 XXXX修改了XXXX。第10章 XXXX本章增加了对XXX功能的描述。文档版本 01 (2005-6-16 起草人：XXX)最初版本。上海迅时通信设备有限公司 版权所有，未经允许不能外传 第70/70页目 录1 控制命令（Control）：由第三方向OM发送命令，返回相应XML51.1 查询（Query）：ext，deviceinfo，group，menu，park，visitor，outer，radio51.1.1 分机查询（Ext）：查询分机296参数、状态等相关信息。51.1.2 设备硬件查询（Deviceinfo） ：查询设备硬件等相关信息。81.1.3 分组查询（Group）：查询分组相关信息。91.1.4 菜单查询（Menu）：查询菜单相关信息。111.1.5 等待区域查询（Park）：查询等待区域分组相关信息。121.1.6 外线呼入查询（Visitor）：查询外线呼入相关信息。131.1.7 本地呼出查询（Outer）：查询本地呼出相关信息。141.1.8 录音查询（Radio）：查询录音相关信息。151.2 配置（Assign）：ext，menu，radio151.2.1 分机配置（Ext）：配置分机的相关属性。151.2.2 菜单配置（Menu）：配置菜单的相关属性。181.2.3 录音配置（Radio）：配置录音的相关属性。191.3 挂断（Clear）：ext，visitor，menu201.3.1 分机挂断（Ext）：挂断与分机相关的所有通话。201.3.2 外线挂断（Visitor）：挂断与外线相关所有通话。211.3.3 菜单挂断（Menu）挂断与菜单相关所有通话。211.4 坐席挂起（Suspend）：仅作用于visitor与ext通话，ext与ext则挂断221.5 取消挂起（Resume）：仅作用于visitor与ext通话，ext与ext则挂断231.6 呼叫保持（Hold）231.7 取消保持（Unhold）241.8 录音开始（Recordstart）：开始录音。241.9 录音结束（Recordend）：结束录音。252 控制命令（Transfer）：由第三方向OM发送命令，返回相应XML262.1 连接（Connect）：ext，group，menu，park，outer，radio262.1.1 转接分机（Ext）：将客户电话139*连接到分机2001。262.1.2 转接分组（Group）将客户电话139*连接到分组3。272.1.3 转接菜单（Menu）将客户电话139*连接到菜单1。282.1.4 转接外线（Outer）：将客户电话139*转接给外线61202701。292.1.5 转接录音（Radio）：将客户电话139*转接给录音1。292.1.6 转接等待区域（Park）：将客户电话139*转接给等待区1。302.1.7 菜单呼出（暂无效果）312.1.8 来电互接（暂无效果）322.1.9 仅作用与visitor与ext，ext与ext则挂断分机呼叫（Outer/Ext）：分机呼叫外线或者其他分机。322.1.10 来电互接（Callback）：332.2 队列（Queue）：ext，group342.2.1 分机队列（Ext）：将客户电话139*连接到分机2001的队列。342.2.2 分组队列（Group）：将客户电话139*连接到分组3的队列。353 事件（Event）：由OM主动返回给第三方373.1 用户按键信息汇报（DTMF）373.2 转接成功（transient）：ext，group，menu，park，visitor，outer，radio373.2.1 Visitor转接menu成功373.2.2 Visitor转接group成功373.2.3 Visitor转接park成功373.2.4 Visitor转接ext成功383.2.5 Visitor转接outer成功383.2.6 Ext呼叫outer成功383.3 回铃（Alert）383.4 接通（Answered）：ext，visitor，outer383.4.1 Visitor与ext383.4.2 Ext与outer383.4.3 Visitor与outer393.4.4 Outer与outer接通393.5 通话结束（Bye）：ext，visitor，outer393.5.1 Ext与visitor通话结束393.5.2 Ext与outer通话结束393.5.3 Visitor与outer通话结束393.5.4 Outer与outer通话结束393.6 分机空闲（IDLE）：仅在分机开启API时汇报393.7 分机忙（BUSY）404 实体状态（Status）：当第三方发起查询时，OM应答，否则不发送414.1 分机（Ext）详细参见查询分机414.2 菜单（Menu）414.3 分组（Group）414.4 呼入（Visitor）414.5 呼出（Outer）425 通话记录（CDR）：由OM主动发送给第三方436 返回代码（Response code）：OM API的返回值507 附录517.1 关键字描述表517.2 典型流程描述537.2.1 例一：用户打入-CRM将用户转接至IVR1-转接至IVR2-转接至分机-分机挂起-解除挂起537.2.2 例二：分机外呼567.2.3 例三：callback571 控制命令（Control）：由外部系统向OM发送命令1.1 查询（Query）：ext，deviceinfo，group，menu，park，visitor，outer，radio1.1.1 分机查询（Ext）：查询分机配置参数、状态等相关信息。命令格式举例：（若本机IP经OM设备认证则无需此项）参数说明：username账号（若本机IP经OM设备认证则无需此项）password密码（若本机IP经OM设备认证则无需此项）ext id分机号码（必须）返回的分机设置状态项 - - no no 1 633 61202888 61202888 61202888 61202888 fring1.dat 159* *com on/off 22222,44444,555555 ready/active/block talk/progress/wait (通话1) talk/progress/wait (通话2) Call_Pickup代接yes（默认值）开启，no关闭（开启则返回无此项；）Call_Forward呼叫转移（开启则无此项）Call_Restriction呼叫权限 0内线，1市话，2国内，3国际recordStart录音开关（默认关闭，关闭则无此项）state通话状态staffid分机所对应的员工工号。可选。mobile分机所对应的员工的手机号码。可选。用于手机和分机绑定、同振、或呼叫转移时的缺省配置。group分机所属的分组。可选。（同一分机可以属于若干个group。）park分机所属的park。可选。（同一分机可以属于若干个park。）voicefile分机彩铃文件。可选。email员工的电子邮件地址。可选。目前暂时没有对应功能。Disturb允许免打扰。on 开启，off关闭。Black_List黑名单All_Fwd_Number无条件转移号码Busy_Fwd_Number遇忙转移号码No_Answer_Fwd_Number无应答转移号码Offline_Fwd_Number离线转移号码状态表Ready分机空闲Active分机摘机或振铃或通话中Block分机挂起（suspend）Talk通话中Progress等待中或通话挂起Wait队列中（queue）注，特殊格式的返回结果结果一：模拟分机摘机（active） - - active - talk 结果二：外线电话转接（transfer）到分机 - - active - talk/wait - wait 结果三：分机呼出到外线（outer to） - - active - talk 错误指令的返回结果Unauthorizederror 401认证不通过Not Found error 404分机未找到结果一：用户名密码出错 结果二：用户名密码认证通过，但分机号与用户名不对应Error 404 Not Found1.1.2 设备硬件查询（Deviceinfo） ：查询设备硬件等相关信息。命令格式举例（若本机IP经OM设备认证则无需此项） 参数说明若未经过IP认证Username用户名（只有Operator Account才有查询权限）Password密码经过IP认证则始终有查询权限正确指令的返回结果 - New Rock Technologies, Inc Rev 1.0.2 OM10-4S/4 Rev 0 - Manufacturer生产商model硬件版本version软件版本ext lineid模拟/IP 分机对应端口编号line lineid模拟/IP 外线对应端口编号group id分组号码ext id组内分机号码1.1.3 分机组查询（Group）：查询分机组成员和接入到分组的来电。命令格式举例 （若本机IP经OM设备认证则无需此项） 参数说明username账号（若本机IP经OM设备认证则无需此项）password密码（若本机IP经OM设备认证则无需此项）group id分组号码正确指令的返回结果结果一:group id为空,则显示分组列表 - - - - - group id分组号码ext id组内分机号码结果二:查询对应group id - - - 结果三:外线转接在分组队列中 - - 错误指令的返回结果结果一:group id不存在 - - - - 1.1.4 菜单查询（Menu）：查询菜单配置信息和接入到菜单的来电。命令格式举例（若本机IP经OM设备认证则无需此项） 参数说明username账号（若本机IP经OM设备认证则无需此项）password密码（若本机IP经OM设备认证则无需此项）menu id菜单号码正确指令的返回结果结果一:menu id为空,则显示菜单列表 - - welcome1.dat 5 # - - goodbye.dat 5 # - 结果二:查询对应menu id - - goodbye.dat 5 # - 结果三：若有visitor转接到menu - - welcome.dat 5 # （多次转接则存在重复） 错误指令的返回结果结果一:menu id为不存在的菜单号 - - - 1.1.5 呼叫寄存查询（Park）：查询寄存区中来电。命令格式举例 参数说明Park id寄存区序号正确指令的返回结果结果一：查询所有寄存区（序号为空）寄存区中有来电： - - - 寄存区中无来电： - - 结果二：查询指定寄存区 - - 错误指令的返回结果结果一: park id为不存在的分组号 - - 1.1.6 来电查询（Visitor）：查询来电的当前状态。命令格式举例 参数说明Visitor id来电标识号正确指令的返回结果结果一：查询当前所有来电的状态（来电标识号为空）有来电： - - talk - wait 参数说明visitorid来电的标识号from来电的主叫号to来电拨打的号码（被叫号）statetalk 通话中，wait 等待中无来电： - - 结果二：查询指定来电 - - wait 错误指令的返回结果结果一：visitor id不存在 - - 1.1.7 呼出电话查询（Outer）：查询当前呼出电话的状态。命令格式举例 参数说明Outer id呼出电话的标识号正确指令的返回结果结果一： 查询所有呼出电话状态（呼出电话的标识号为空）有呼出电话： - - - 参数说明outerid呼出电话的标示号from主叫号to被叫号trunk出局中继线路的号码无呼出电话： - - 结果二：查询指定呼出电话 - - 错误指令的返回结果结果一：outer id不存在 - - 1.1.8 播音查询（Radio）：查询驻留在播音区的来电。命令格式举例 参数说明Radio id播音区序号正确指令的返回结果结果一：查询所有播音区（播音区序号为空） - - - 结果二：查询指定播音区 - - 错误指令的返回结果结果一:radio id为不存在的录音号 - - 1.2 配置命令（Assign）：ext，menu，radio，group1.2.1 分机配置（Ext）：配置分机参数。命令格式举例20063313888888888230/1/2/3on/off22222,44444,5555551/2/3 6120288861202888数说明lineid分机线路号（系统固定，不可更改）id分机号码（必须）staffid员工工号（可选）mobile员工的手机号码（可选）用于手机和分机绑定、同振、或呼叫转移时的缺省配置。group分机所属的分机组（可选）注，同一分机可以属于若干个group。park分机的寄存区（可选）注，同一分机可以属于若干个park。voicefile分机彩铃的语音文件（可选）email员工的电子邮件地址（可选）目前暂时没有对应功能。call_restriction呼叫权限 0内线，1市话，2国内，3国际Disturb允许免打扰。on 开启，off关闭。Black_List黑名单 Ft_Fwd_Type呼转方式 1 关闭 2 全转 3遇忙或无应答转Fwd_Number呼转号码Offline_Fwd_Number离线呼转号码Fork同振号码正确指令的返回结果 - - 633 61202888 61202888 61202888 0 fring1.dat offline/ready/talk/progress DisturbBlack_ListOffline_Fwd_Number