- PDF 免费下载

Size: px

Start display at page:

Download ""

熊孟
5 years ago
Views:

1 Action URL 和 Active URI 规范说明版本 : <V0.0.4> 发布日期 : < >

2 目录目录修订历史介绍概述目标受众术语表参考资料 Action URL 介绍协议说明 Action URL 配置事件列表变量列表 Active URI 介绍指令列表协议说明 Active URI 支持送一组号码功能

3 1 修订历史修订历史 : 版本作者发布时间说明 Tony 初始版本 guoyuxing 更新 Action URI 指令列表添加文档适用范围更新 Action url 和 Active URI 指令列表添加文档适用范围 -X 系列 Bingfei. Gao 更新 $remote$local$display_local$display_remote 变量说明 2

4 2 介绍 2.1 概述 Action URL 是话机将当前的状态上报给远端控制台 Active URI 是远端控制台控制话机进行各种操作 Action URL 和 Active URI 主要应用于 CTI(Computer Telephony Intergration) 场景中话机上报自身状态给 PC,PC 控制话机各种操作典型的应用场景, 比如 : 呼叫中心话务员在 PC 上通过 CTI 应用软件, 操作话机 2.2 目标受众 Fanvil 话机测试人员, 话机管理员基于 Fanvil 话机开发 CTI 应用软件的技术人员 2.3 术语表 CTI 计算机电话技术集成 (Computer Telephony Integration) 通过软硬件接口及控制设备把电话通信和计算机信息处理集成在一起, 实现对话音传真和数据通信的控制和综合应用事件话机的状态改变后触发的一个消息 2.4 参考资料无 3

5 3 Action URL 3.1 介绍 Action URL 是在话机自身状态发生变化时, 话机向远端控制台发起 HTTP Get 请求, 将这一事件发送给远端控制台, 控制台可以根据该状态变化, 进行相应的话机操作 3.2 协议说明 Action URL 的 HTTP URL 格式由控制台的 HTTP Server 端来定义, 话机只负责当相应状态变化时发起 HTTP Get 请求一般情形下,Action URL 的 HTTP URL 格式为 : /newcall.xml?num=$call_id 远端控制台的 IP 地址 ; newcall.xml? 远端控制台 HTTP Server 定义的各个状态对应的处理方法 ; $call_id 话机内部支持的变量, 在发起 HTTP Get 请求前, 系统会自动将该变量替换为系统当前的真实值内部变量以 $ 开头 3.3 Action URL 配置登陆话机的 Web 管理页面, 进入 Phone -> Feature -> Action URL Settings, 在每一个事件对应的输入框中, 输入相应的 URL 比如:Incoming Call 事件后, 输入 /newcall.xml?num=$call_id 配置后有新来电, 来电号码为 1234, 话机会发起 HTTP Get /newcall.xml?num=1( 第几路通话 ) 4

3.3.1 事件列表事件名称 Setup Completed Registration Succeeded Registration Disabled Registration Failed Phone Off Hooked Phone On Hooked Incoming call Outgoing call Call established Call terminated DND

6 3.3.1 事件列表事件名称 Setup Completed Registration Succeeded Registration Disabled Registration Failed Phone Off Hooked Phone On Hooked Incoming call Outgoing call Call established Call terminated DND Enabled DND Disabled Unconditional Call Forward Enabled Unconditional Call Forward Disabled Call Forward on Busy Enabled Call Forward on Busy Disabled Call Forward on No Answer Enabled 事件说明话机启动完成帐号注册成功帐号取消注册帐号注册失败摘机挂机有新呼叫进来呼出电话通话建立通话结束 DND 开启 DND 关闭无条件前转打开无条件前转关闭遇忙前转打开遇忙前转关闭无应答前转打开 5

7 Call Forward on No Answer Disabled Call transfer Unattended Call Transfer Attended Call Transfer Call hold Call resume Mute Unmute Missed calls IP Changed Idle To Busy Busy To Idle MWI SMS Start reboot 无应答前转关闭呼叫转移呼叫盲转呼叫出席转移呼叫保持取消呼叫保持静音开启静音关闭有未接来电更换话机 ip 话机从待机到其他界面话机从其他界面到待机留言短信重启变量列表变量名变量说明 $mac 设备 MAC 地址 $ip 当前可用 IP 地址 $model 话机型号 $firmware 软件版本号 $active_url 当前活动帐号的 SIP URI( 仅在呼入呼出通话中生效 ) $active_user 当前活动帐号的 SIP URI 的用户帐号部分 ( 仅在呼入呼出通话中生效 ) $active_host 当前活动帐号的 SIP URI 的服务器部分 ( 仅在呼入呼出通话中生效 ) $local X3/4 系列 : 本机的 SIP URI( 呼出时生效 ) 本机的号码 ( 呼入, 未接时生效 ) X6: 本机的 SIP URI( 呼入, 呼出, 通话中生效 ) $remote X3/4 系列 : 远端的 SIP URI( 呼入时生效 ) 远端的号码 ( 呼出, 未接时生效 ) X6: 远端的 SIP URI( 呼入, 呼出, 通话中生效 ) $display_local 本机的 display name( 无 display name 时显示号码 )( 仅在呼入呼出时生效 ) 6

8 $display_remote X3/4 系列 : 远端的 display name( 无 display name 时显示号码 ) ( 仅在呼入时生效 ) X6: 远端的 display name( 无 display name 时显示号码 )( 仅在呼入, 呼出时生效 ) $call_id 通话 ID( 仅在呼入呼出通话中生效 ) $duration 通话时长 ( 仅在通话结束时生效 ) $date_time 获取时间 $memory_free 内存 $flash_free 闪存 ( 暂没有实现 ) $line 做通话的 line 线 ( 呼入呼出通话中注册时候生效 ) $local_user 通话的本地 users( 呼入呼出通话中生效 ) $local_server sip 通话使用的服务器 ( 呼入呼出通话中生效 ) $local_domain sip 通话的 domain( 呼入呼出通话中生效 ) $local_number 本机的通话号码 ( 呼入呼出通话中生效 ) $local_displayname 本机通话 displayname( 呼入呼出通话中生效 ) $remote_number 通话中远端号码 ( 呼入呼出通话未接来电中生效 ) $remote_displayname 通话中远端号码的 displayname( 呼入呼出通话中生效 ) 注 : 绿色字体的变量目前仅在 x6 生效注 : 1) 仅在呼入时生效, 指只有当 Incoming call 选项中填写了该变量时, 该变量才会替换为相应的信息 2) 仅在呼出时生效, 指只有当 Outgoing call 选项中填写了该变量时, 该变量才会替换为相应的信息 3) 仅在通话中生效, 指只有当 Call established Call terminated Transfer call Blind transfer call Attended transfer call Hold Unhold Mute Unmute 等跟通话相关的选项中填写了该变量时, 该变量才会替换为相应的信息 7

9 4 Active URI 4.1 介绍 Active URI 是由远端控制台发起 HTTP Get 请求, 话机内置的 HTTP Server 来解析指令和响应该请求, 以达到远端控制话机的目标 4.2 指令列表指令名称 key=ok key=enter key=f_ok key=f_cancel key=x key=f_release key=release key=speaker key= F_HANDFREE key= F_HANDSFREE key= F_SEND key=f_accept key=f_reject key=headset key=f_headset key=rd key=f_redial key=f_speeddial key=up DOWN LEFT RIGHT key=f_up F_DOWN F_LEFT F_RIGHT key=volume_up key=f_volume_up key=volume_down key=f_volume_ DOWN key= F_DELETE key=delete key=msg key=f_mwi key=f_sms key=f_memo key= F_PBOOK key=f_service key=f_callers key=mute key=f_mute Key=F_LOCK 指令说明确认键, 可以接听电话 ; 摘机 ; 发送号码 ; 待机下进入菜单等退出键, 可以挂断电话 ; 拒接 ; 退出拨号等返回待机免提键, 打开关闭免提发送键接听键拒接键耳机键重播键快速拨号键导航键, 上下左右音量键, 增大音量音量键, 减小音量删除键进入语音信箱短信息键进入备忘录进入电话本网络电话本快捷键进入呼叫记录静音键键盘锁 8

10 key=dnd 免打扰键, 进入免打扰设置菜单 key=dndon DND 关闭时, 进入免打扰设置 key=dndoff DND 打开时, 进入免打扰设置 key=f_rec 语音留言键 key=f_power 电源灯设置 key=f_sdtmf DTMF 设置 key=f_flash 在两路通话间切换并自动建立通话 key=f_prefix 前缀 key=f_hotdesking hot desk 键 key=f_agent 进入 Agent 设置 key=f_disposition Broadsoft CallCenter 应用标记通话记录类型 ( 通话时或者拨号时按下生效 ) key=f_escalate Broadsoft CallCenter 应用中实现一键将管理者加入进行三方的功能 key=f_trace Broadsoft CallCenter 应用中用于通知服务器记录一次通话的功能 ( 通话时或者拨号时按下生效 ) key=f_privatehold Broadsoft Shared Call appearance 中保持对方但是不共享保持信息的功能, 相对于 public hold 键 ( 即 hold 键 ) key=f_hold 呼叫保持键 key=f_cfwd 进入呼叫前转设置 key=f_divert 呼叫前转键 key=f_transfer key=f_a_transfer 转移键, 通话中执行转移操作 key=f_b_transfer 盲转键 key=f_conference 三方会议键 key=f_join 加入 key=f_pickup 抢接 key=f_park 来电驻留 key=f_lor key=f_callback 回拨 key=f_autoredial 自动拨号 ( 拨号时按下生效 ) key=f_unautoredial 结束拨号 ( 拨号时按下生效 ) key=0-9 key=f_0-f_9/f_*/ F_STAR 数字键 key=* key=f_* key=f_star * 键 key=# key=pound key=f_ POUND # 键 key=l1-l4 key=f_l1-f_l4 选线键,Line1~4 key=d1-d8 key=f_d1-f_d4 DSS 键,DSS Key 1~8 9

11 key=f1-f4 key=f_f1-f_f4 功能键 softkey 1-4 key=reboot key=f_reboot 重启键 key=autop 重启配置键, 重新发起 autoprovision 检测 ( 现在还未实现 ) key=f_lock&code=opencode 实现远程开门的功能 key=f_grouplisten 组听 key=f_localcontacts 本地电话本 key=f_lock 上锁 key=exit key=clear key=split key=prev_line/ key=next_line key=prev_call/ key=next_call key=menu 退出 Dialing 下清除输入号码解除会议切换 line 线切换通话菜单 4.3 协议说明 Active URI 的 HTTP URL 的格式为 : 是话机的 IP 地址 ; /cgi-bin/configmanapp.com 是 Active URI 固定的写法, 话机解析到后会认为这是 Active URI 的控制指令 ;?key=ok 是指令类型, 表示话机要执行的动作 ( 一般来说, 这个指令都是一个按键事件 ) 在某些环境下部署使用话机, 考虑到话机的安全, 话机在出厂的时候, 会默认开启 HTTP 认证要求机制, 这个时候 HTTP URL 的格式为 : admin:admin 是话机内置 HTTP Server 的默认认证用户名和密码, 与登陆 Web Management 的用户名密码一致 4.4 Active URI 支持送一组号码功能上述 Active URI 指令一次只支持向话机发起一个操作事件, 比如在输入号码的时候, 一次输入一个键, 操作比较繁琐因此 Active URI 也支持将一组号码带在 URL 中送出携带号码发起呼叫 10

12 NTER 待机状态下话机收到该指令, 话机会先进入免提摘机状态, 再自动呼叫号码 000 携带号码执行盲转操作 0;F_TRANSFER 通话时话机收到该指令, 话机会自动执行转移操作, 并将当前通话盲转给号码

22) 使话机检测 Auto provision 更新 : ) 开启 DND: ) 关闭 DND: ) 使用数字键 0 : ) 使用数字键 1 : ) 使用数字键 2 : ) 使用数字键 3 : ) 使

22) 使话机检测 Auto provision 更新 : ) 开启 DND: ) 关闭 DND: ) 使用数字键 0 : ) 使用数字键 1 : ) 使用数字键 2 : ) 使用数字键 3 : ) 使目录 Action URI 使用说明... 1 1. Action URI... 1 2. 话机配置... 1 3. Action URI 的使用... 2 4.Yealink 话机通过 Action URI 可实现的功能 :... 3 1) 接听来电 :... 3 2) 使用免提键 :... 3 3) 使用转接键 TRAN:... 3 4) 增加音量 :... 3 5) 减小音量 :... 3 6)