ActionURL和ActionURI

最近公司要在IP话机上做ActionURL 跟ActiveURI再此做做笔记整理

1ActionURL与ActiveURI概述

Action URL 是话机将当前的状态上报给远端控制台 是在话机自身状态发生变化时，话机向远端控制台发起HTTP Get请求，将这一事件发送给远端控制台，控制台可以根据该状态变化，进行相应的话机操作。
Action URI 是远端控制台控制话机的各种操作
Action URL和Action URI主要应用于CTI（Computer Telephony Intergration）场景中。话机上报自身状态给PC,PC控制话机各种操作。典型的应用场景，比如：呼叫中心。话务员在PC上通过CTI应用软件操作服务器

2 ActionURL

ActionURL是在话机自身状态发生变化时，话机向远端控制台发起HTTP Get请求，将这一事件发送给远端控制台，控制台可以根据该状态变化，进行相应的话机操作。

2.1 ActionURL

Action URI是由远端控制台发起HTTP Get请求，话机内置的HTTP Server来解析指令和响应请求，已达到远端控制话机的目标

2.2 ActionURL协议说明

Action URL的HTTP URL格式 由控制台的HTTP Server端来定义，话机只负责当响应状态变化是发起HTTP Get请求，一般情况下Action URL的HTTP URL格式为：“http://192.168.0.100/newcall.xml?num=$call_id”

• "192.168.0.100" 远端控制台IP
• “newcall.xml” 远端控制台HTTP Server定义的各个状态对应的处理方法
• "$call_id" 话机内部支持的变量，在发起HTTP Get请求前，系统会自动将该变量替换为系统当前的真实值。内部变量以“$”开头

ActionURL事件列表

事件设定名称	事件名称	事件说明
设置完成	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开启
勿扰功能关闭	DND_Disabled	DND关闭
无条件前传启用	Unconditional_Call_Forward_Enabled	无条件前传打开
无条件前传关闭	Unconditional_Call_Forward_Disabled	无条件前传关闭
忙线转接启用	Call_Forward_on_Busy Enabled	遇忙前传打开
忙线转接关闭	Call_Forward_on_Busy Disabled	遇忙前传关闭
无应答前传启用	Call_Forward_on_No Answer Enable	无应答 前传打开
无应答前传关闭	Call_Forward_on_No Answer Disabled	无应答前传关闭
通话转移	Call_transfer	呼叫转移
非出席通话转移	Unattended_Call_Transfer	呼叫盲转
出席通话转移	Attended_Call_Transfer	呼叫出席转移
通话保持	Call_hold	呼叫保持
恢复通话	Call_resume	取消呼叫保持
麦克风静音	Mute	静音开启
麦克风启用	Unmute	静音关闭
未接来电	Missed_calls	有未接来电
IP地址改变	IP_Changed	更换话机IP
话机忙碌	Idle_To_Busy	话机从待机到其他界面
话机闲置	Busy_To_Idle	话机从其他界面到待机
留言	MWI	留言
短信	SMS	短信
重启	Start reboot	重启

Action URL 变量列表

变量名	变量说明
$mac	设备MAC地址
$ip	当前可用IP地址
$model	话机型号
$firmware	软件版本号
$active_url	当前活动账号的SIP URI(仅在呼入、呼出、通话中生效)
$active_user	当前活动账号的SIP URI的用户账户部分（仅在呼入、呼出、通话中生效）
$active_host	当前活动账号的SIP URI的服务器部分（尽在呼入、呼出、通话中生效）
$local	本机的SIP URI（呼入、呼出、通话中生效）
$remote	远端的SIP URI(呼入、呼出、通话中生效)
$display_local	本机的display name(无display name时显示号码)（尽在呼入、呼出时生效）
$display_remote	远端的的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（呼入、呼出、通话中生效）

3 ActionURI

Action URI是由远端控制台发起HTTP Get请求，话机内置的HTTP Server来解析指令和响应的请求，已达到远端控制话机的目标

3.1 Action URI实例

3.1.1 实例格式1

“http://192.168.0.101/cgi/ConfigManApp.com?key=OK”

• "192.168.0.101" 是话机的IP地址；
• “cgi-bin/ConfigManApp.com”是ActionURI的固定写法，话机解析到后会认为这是Action URI的控制指令
• “？key=OK”是指令类型，表示话机要执行的动作（一般来说，这个指令都是一个按键事件）

3.1.2 实例格式1

http://admin:[email protected]/cgi/ConfigManApp.com?key=OK
"admin:admin"是话机内置HTTP Server的默认认证用户和密码，与登录Web Management的用户密码一致

3.1.3 实例扩展

http://admin:[email protected]/cgi/ConfigManApp.com?key=SPEAKER;000;ENTER
话机待机状态下收到该指令，话机会先进入免提摘机状态，在自动呼叫号码“000”
http://admin:[email protected]/cgi/ConfigManApp.com?key=F_TRANSFER;000;F_TRANSFER
通话时收到该指令，话机会自动执行转移操作，并将当前通话忙转给号码"000"

3.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|F_UP|F_DOWN|F_LEFT|F_RIGHT	导航键，上下左右
key = VOLUME_UP|key=F_VOLUME_UP	音量键 增大音量
key = VOLUME_DOWN|key=VOLUME_DOWN	音量键 减小音量
key = F_DELETE|key=DELETE	删除键
key = MSG|key=F_MWI	进入语音信箱
key = SMS	短信息键
key = F_MEMO	进入备忘录
key=F_PBOOK	进入电话本
key=F_SERVICE	网络电话簿快捷键
key=CALLERS	进入通话记录
key=MUTE|key=F_MUTE	静音键
key=F_LOCK	键盘锁
key=DND	免打扰键，进入免打扰菜单
key=DNDOn	DND关闭时，进入免打扰设置
key=DNDOff	DND打开时，进入免打扰设置
key=REC	语音留言键
key=POWER	电源灯设置
key=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=CONFERENCE	三方会议键
key=F_JOIN	加入
key=F_PICKUP	抢接
key=F_PARK	来电驻留
key=F_LOR|key=F_CALL_BACK	回拨
key=F_AUTOREDIAL	自动拨号(拨号时按下生效)
key=F_UNAUTOREDIAL	结束拨号(拨号时按下生效)
key=0-9|*|#|F_0-F_#	数字键 0-9,*,#
key=L1-L4|key=F_L1-F_L4	选线，Line1~4
key=D1-D8|key=F_D1-F_D8	DSS键，DSS Key 1~8
key=F1-F4	功能键 softkey 1-4
key=Reboot|key=F_REBOOT	重启键
key=AutoP	重启配置键，重启发起autoprovision检测（还未实现）
key=F_LOCK&&code=openCode	实现远程开门功能
key=F_GOUPLISTEN	组听
key=F_LOCALCONTACTS	本地电话本
key=F_LOCK	上锁
------	------
key=exit	退出
key=clear	Dialing下清除输入号码
key=split	解除会议
key=prev_line/key=next_line	切换line线
key=prev_call/key=next_call	切换通话
key=menu	菜单	d