话机上报动作Action Url 使用说明

服务支持SUPPORT

2024-05-07

1. Action URL是什么

Action URL，就是话机端一个动作（如摘机，挂机，来电，去电等）产生一个URL，该URL可由用户自定义的。当产生某个动作的时候，话机即发出对用户设定的URL的HTTP Get，从而达到上报自身动作的目的。

比如在电脑端安装一个软电话，话机端每发生一个动作就把该行为上报给软电话，软电话相应的产生某个动作如拨出电话，开启DND等。该功能与Active URI相配合从而实现话机与电脑端的相互控制。

话机支持上报的话机状态有：启动完成、注册帐号、注销帐号、帐号注册失败、摘机、挂机、来电、呼出、已建立通话、挂断通话、开启免打扰、关闭免打扰、开启无条件前转、关闭无条件前转、开启遇忙前转、关闭遇忙前转、开启无应答前转、关闭无应答前转、转移、盲转、咨询/半咨询转、保持、取消保持、静音、取消静音、未接来电、IP改变、闲置转入通话、通话转入闲置。共支持29种话机动作状态。

2. 话机URL配置

说明进入“话机配置－>Action URL”进行设置。在该页面中选择需要话机上报的动作，填写自定义URL。如下图所示：

上图中:

http://10.1.4.26/outgoing.xml?ip=$ip

10.1.4.26指的是服务器地址，outgoing指话机此时的状态为呼出，ip=$ip表示本话机的IP地址。最终整条表示本话机去电时，服务器(10.1.4.26)收到ip地址为$IP的话机处于呼出的状态.

http://10.1.4.26/DNDOn.xml?mac=$mac

10.1.4.26指的是服务器地址，DNDOn指话机此时的状态为开启免打扰，mac=$mac表示本话机的MAC地址。最终整条表示话机开启免打扰时，服务器(10.1.4.26)收到Mac地址为$MAC的话机设置了DND的状态.

3. Action URL格式说明

URL格式：http://internal.server.net/help.xml?变量=$变量

注：（1）internal.server.net为服务器地址。

（2）help.xml 中的help为话机状态,可自行定义

如此时话机的状态为来电，可将help改写为incomingcall。如http://10.1.4.26/incomingcall.xml?mac=$mac. 当话机端来电时,话机会把本话机的MAC地址(如00156519ab35)和来电动作告知服务器(10.1.4.26).

Action URL所支持的变量（12种）说明：

变量是指：话机以何种形式上报给服务器自己的状态.如$MAC

（设服务器地址为：10.1.4.26）

变量	URL格式	说明
$mac	http://10.1.4.26/help.xml?mac=$mac	以话机的MAC地址上报给服务器
$ip	http://10.1.4.26/help.xml?ip=$ip	以话机的IP地址上报给服务器
$model	http://10.1.4.26/help.xml?model=$model	以话机的话机型号上报给服务器
$firmware	http://10.1.4.26/help.xml?firmware=$firmware	以话机的固件版本上报给服务器
$active_url	http://10.1.4.26/help.xml?active_url=$active_url	以话机的当前活动账号的SIP URI 上报给服务器(仅在呼入、呼出、通话中生效)
$active_user	http://10.1.4.26/help.xml?active_user=$active_user	以话机的当前活动账号的SIP URI的用户账号部分上报给服务器(仅在呼入、呼出、通话中生效)
$active_host	http://10.1.4.26/help.xml?active_host=$active_host	以话机的当前活动账号的SIP URI的服务器部分上报给服务器(仅在呼入、呼出、通话中生效)
$local	http://10.1.4.26/help.xml?local=$local	以被呼叫者的SIP URI，上报给服务器(仅在呼入、呼出时生效)
$remote	http://10.1.4.26/help.xml?remote=$remote	以呼叫者的SIP URI上报给服务器(仅在来电时生效)
$display_local	http://10.1.4.26/help.xml?display_local=$display_local	以被呼叫者的display name上报给服务器（仅在呼入、呼出时生效）
$display_remote	http://10.1.4.26/help.xml?display_remote=$display_remote	以呼叫者的display name上报给服务器（仅在来电时生效）
$call_id	http://10.1.4.26/help.xml?call_id=$call_id	以通话ID上报给服务器（仅在呼入、呼出、通话中生效）