Wiwiz Setup API参考手册与接口规范

[修改履历]
Ver 1.1 : 查询、添加电子招待券添加最大用户数参数client_num。(2014.7.10)
Ver 1.2 : 新增修改电子招待券接口;删除电子招待券接口voucher_id支持多值。(2015.1.5)
Ver 1.3 : 新增插播广告功能接口。(2015.6.26)
Ver 1.4 : 插播广告功能接口中增加不触发关键字参数。(2016.1.18)
Ver 1.5 : 新增删除电子招待券接口2(即delete_voucher_by_name)。(2017.9.19)

 
目录.
1. 功能描述
2. 使用条件与准备工作
3. 调用概要
4. 共通说明
5. 接口规范
  5.1 查询热点基本信息
  5.2查询热点详细设置信息
  5.3 创建新热点
  5.4 修改热点设置
  5.5 删除热点
  5.6 查询电子招待券
  5.7 添加电子招待券
  5.8 修改电子招待券
  5.9 删除电子招待券
  5.10 删除全部电子招待券
  5.11 查询访问控制规则
  5.12 添加访问控制规则
  5.13 修改访问控制规则
  5.14 删除访问控制规则
  5.15 获取插播广告功能状态
  5.16 修改插播广告功能状态
  5.17 获取所有插播广告
  5.18 添加插播广告
  5.19 修改插播广告
  5.20 删除插播广告

6. 注解

1. 功能描述
Wiwiz Setup API是Wiwiz HotSpot Builder提供的基于Web的外部开发接口。调用它可以用于查询热点信息,创建、修改、删除热点,查询、添加、删除电子招待券,查询、创建、修改、删除访问控制规则等。

2. 使用条件与准备工作
1. 已拥有Wiwiz专业版账户。
2. 查询Wiwiz账户的User Key。
查询User Key的方法是:登录Wiwiz Web面板,点击“用户菜单”页面上的“升级选项”->“查询User Key”。

3. 调用概要
调用本API时,用户需向指定URL发送HTTP请求,发送请求时应根据接口规范指定参数(POST方式)。结果数据以HTTP响应的形式(XML格式)返回。

4. 共通说明
1. 请求URL:
所有的请求都必须发送至 http://cp.wiwiz.com/as/s/setupapi/
所有的HTTP请求参数必须以HTTP POST的方式传送。

2. 共通请求参数:
所有的请求都必须包含以下HTTP请求参数:

参数名 必须/可选 说明
userkey 必须 设为用户自己的User Key
sign 必须 Wiwiz账户名的MD5值,即,MD5({username})



5. 接口规范
5.1. 查询热点基本信息
请求参数说明:

参数名 必须/可选 说明
command 必须 固定值:list_hotspot

返回数据示例与说明:

<?xml version="1.0" encoding="UTF-8"?>
<result>
  <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功;如果为以ERR开头的文字,则代表错误(*注1) -->
      <code>OK</code>
      <!-- message:  调用结果状态说明(供调试参考) -->
      <message>Operation Completed</message>
  </status>
  <data> <!-- 仅在code为OK时出现 -->
      <record> <!-- 每个record标签代表一条热点信息记录 -->
          <hotspot_id>1374085CF3C</hotspot_id> <!-- HotSpot ID -->
          <name>XXXXXX</name> <!-- 热点名称 -->
          <running_status>1</running_status> <!-- 认证接受状态。1代表接受认证,0代表拒绝认证 -->
      </record>
  </data>
</result>

5.2. 查询热点详细设置信息
请求参数说明:

参数名 必须/可选 说明
command 必须 固定值:hotspot_settings
hotspot_id 必须 热点的HotSpot ID

返回数据示例与说明:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功;如果为以ERR开头的文字,则代表错误 -->
        <code>OK</code>
        <!-- message:  调用结果状态说明(供调试参考) -->
        <message>Query Completed</message>
    </status>
<data> <!-- 仅在code为OK时出现 -->
        <name>XXXXXX</name> <!-- 热点名称-->
        <running_status>1</running_status> <!-- 认证接受状态。1代表接受认证,0代表拒绝认证 -->
        <location>XXXX</location> <!-- 地点/街道地址 -->
        <timezone>Etc/GMT-8</timezone> <!-- 所在时区 -->
        <longitude></longitude> <!-- 经度 -->
        <latitude></latitude> <!-- 纬度 -->
        <owner_name>XXXX</owner_name> <!-- 管理员姓名 -->
        <owner_contact>XXXX</owner_contact> <!-- 管理员联系方式 -->
        <auth_agree>0</auth_agree> <!-- 要求认同条款认证方式。1代表启用,0代表禁用 -->
        <auth_voucher>0</auth_voucher> <!-- 电子招待券认证方式。1代表启用,0代表禁用 -->
        <auth_login>1</auth_login> <!-- 要求登录认证方式。1代表启用,0代表禁用 -->
        <logintype>0</logintype> <!-- 0代表“Wiwiz.com注册用户”方式,1代表“自定义账户”方式 -->
        <single_login>0</single_login> <!-- 禁止同一用户同时使用多个客户端。1代表启用,0代表禁用 -->
        <auth_api>0</auth_api> <!-- 调用Wiwiz Auth API认证方式。1代表启用,0代表禁用 -->
        <authapi_url></authapi_url> <!-- 认证URL(Wiwiz Auth API) -->
        <auth_sms>0</auth_sms> <!-- 手机验证认证方式。1代表启用,0代表禁用 -->
        <phone_country></phone_country> <!-- 国家地区代码(手机验证) -->
        <phone_repeat_interval>1</phone_repeat_interval> <!-- 重复验证间隔(手机验证) -->
        <phone_valid_interval>30</phone_valid_interval> <!-- 验证码有效期(手机验证) -->
        <phone_resend>0</phone_resend> <!-- 允许验证码有效期内重发短信(手机验证)。1代表启用,0代表禁用 -->
        <phone_maxtimes>5</phone_maxtimes> <!-- 每号码每日限制次数(手机验证) -->
        <phone_onlyonce>0</phone_onlyonce> <!-- 验证码仅限使用一次(手机验证)。1代表启用,0代表禁用 -->
        <phone_blacklst></phone_blacklst> <!-- 手机号码黑名单(手机验证)。多个值以“;”字符间隔 -->
        <phone_magic_code></phone_magic_code> <!-- 万能验证码(手机验证)。多个值以“;”字符间隔 -->
        <timeout>10</timeout> <!-- 认证超时 -->
        <isfree>0</isfree> <!-- 认证是否收取费用。1代表收费,0代表免费 -->
        <fee_min></fee_min> <!-- 费率(每分钟) -->
        <fee_quarter></fee_quarter> <!-- 费率(每一刻钟/15分钟) -->
        <fee_halfhr></fee_halfhr> <!-- 费率(每30分钟)  -->
        <fee_hr></fee_hr> <!-- 费率(每小时) -->
        <fee_day></fee_day> <!-- 费率(每天)  -->
        <fee_week></fee_week> <!-- 费率(每周) -->
        <fee_month></fee_month> <!-- 费率(每月) -->
        <fee_year></fee_year> <!-- 费率(每年) -->
        <currency></currency> <!-- 币种 -->
        <trial_time>0</trial_time> <!-- 可试用时长(分钟) -->
        <trymac_chk>0</trymac_chk> <!-- 阻止同一MAC地址设备重复试用。1代表启用,0代表禁用 -->
        <whiteaddr></whiteaddr> <!-- 域名/IP地址白名单。多个值以“;”字符间隔 -->
        <blackaddr></blackaddr> <!-- 域名/IP地址黑名单。多个值以“;”字符间隔 -->
        <incoming_max></incoming_max> <!-- 每连接最大接收流量 -->
        <outgoing_max></outgoing_max> <!-- 每连接最大发送流量 -->
        <authpage_type>1</authpage_type> <!-- 认证页面类型。0: 自定义URL; 1~99: 默认认证页面; 9999: 自定义HTML -->
        <authpage_url></authpage_url> <!-- 自定义认证页面URL -->
        <authpage_html></authpage_html> <!-- 自定义HTML -->
        <postauthpage_type></postauthpage_type> <!-- 认证后页面类型。0: 自定义URL; 1: 默认页面; 9999: 自定义HTML -->
        <postauthpage_url></postauthpage_url> <!-- 自定义认证后页面URL -->
        <postauthpage_html></postauthpage_html> <!-- 自定义认证后页面HTML -->
    </data>
</result>

5.3 创建新热点
请求参数说明:

参数名 必须/可选 默认值 最大长度(Bytes) 说明
command 必须 固定值:create_hotspot
name 必须 255 热点名称
running_status 可选 1 1 认证接受状态。1代表接受认证,0代表拒绝认证
location 可选 255 地点/街道地址
timezone 可选 255 所在时区。可选值范围参考*注2
longitude 可选 15 经度
latitude 可选 15 纬度
owner_name 可选 255 管理员姓名
owner_contact 可选 255 管理员联系方式
auth_agree 可选 0 1 要求认同条款认证方式。1代表启用,0代表禁用
auth_voucher 可选 0 1 电子招待券认证方式。1代表启用,0代表禁用
auth_login 可选 0 1 要求登录认证方式。1代表启用,0代表禁用
logintype 可选 0 1 0代表“Wiwiz.com注册用户”方式,1代表“自定义账户”方式
single_login 可选 0 1 禁止同一用户同时使用多个客户端。1代表启用,0代表禁用
auth_api 可选 0 1 调用Wiwiz Auth API认证方式。1代表启用,0代表禁用
authapi_url 可选 255 认证URL(Wiwiz Auth API)
auth_sms 可选 0 1 手机验证认证方式。1代表启用,0代表禁用
phone_country 可选 20 手机验证的国家地区代码。可选值范围参考*注3
phone_repeat_interval 可选 1 11 手机验证的重复验证间隔(分钟)
phone_valid_interval 可选 60 11 手机验证的验证码有效期(分钟)
phone_resend 可选 0 1 允许验证码有效期内重发短信。1代表启用,0代表禁用
phone_maxtimes 可选 5 11 每号码每日限制次数(手机验证)
phone_onlyonce 可选 0 1 验证码仅限使用一次(手机验证)。1代表启用,0代表禁用
phone_blacklst 可选 65535 手机号码黑名单(手机验证)。多个值以“;”字符间隔
phone_magic_code 可选 65535 万能验证码(手机验证)。多个值以“;”字符间隔
timeout 可选 10 11 认证超时
isfree 可选 0 1 认证是否收取费用。1代表收费,0代表免费
fee_min 可选 12 费率(每分钟)
fee_quarter 可选 12 费率(每一刻钟/15分钟)
fee_halfhr 可选 12 费率(每30分钟)
fee_hr 可选 12 费率(每小时)
fee_day 可选 12 费率(每天)
fee_week 可选 12 费率(每周)
fee_month 可选 12 费率(每月)
fee_year 可选 12 费率(每年)
currency 可选 20 币种。可选值范围参考*注4
trial_time 可选 11 可试用时长(分钟)。仅限整数。
trymac_chk 可选 0 1 阻止同一MAC地址设备重复试用。1代表启用,0代表禁用
whiteaddr 可选 65535 域名/IP地址白名单。多个值以“;”字符间隔
blackaddr 可选 65535 域名/IP地址黑名单。多个值以“;”字符间隔
incoming_max 可选 255 每连接最大接收流量(MB)
outgoing_max 可选 255 每连接最大发送流量(MB)
authpage_type 可选 1 11 认证页面类型。0: 自定义URL; 1~99: 默认认证页面; 9999: 自定义HTML
authpage_url 可选 255 自定义认证页面URL
authpage_html 可选 65535 自定义HTML
postauthpage_type 可选 1 11 认证后页面类型。0: 自定义URL; 1: 默认页面; 9999: 自定义HTML
postauthpage_url 可选 255 自定义认证后页面URL
postauthpage_html 可选 65535 自定义认证后页面HTML

返回数据示例与说明:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功;如果为以ERR开头的文字,则代表错误 -->
        <code>OK</code>
        <!-- message: 调用结果状态说明(供调试参考)-->
        <message>HotSpot Created</message>
    </status>
<data> <!-- 仅在code为OK时出现 -->
        <!-- 创建的热点的HotSpot ID -->
        <hotspot_id>14006BD8DC6</hotspot_id>
    </data>
</result>

5.4 修改热点设置
请求参数说明:

参数名 必须/可选 默认值 最大长度(Bytes) 说明
command 必须 固定值:change_hotspot
hotspot_id 必须 热点的HotSpot ID
其他参数与“5.3”相同

返回数据示例与说明:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功;如果为以ERR开头的文字,则代表错误 -->
        <code>OK</code>
        <!-- message: 调用结果状态说明(供调试参考)-->
        <message>HotSpot Updated</message>
    </status>
</result>

5.5 删除热点
请求参数说明:

参数名 必须/可选 说明
command 必须 固定值:delete_hotspot
hotspot_id 必须 热点的HotSpot ID

返回数据示例与说明:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功;如果为以ERR开头的文字,则代表错误 -->
        <code>OK</code>
        <!-- message: 调用结果状态说明(供调试参考)-->
        <message>HotSpot Deleted</message>
    </status>
</result>

5.6 查询电子招待券
请求参数说明:

参数名 必须/可选 说明
command 必须 固定值:list_voucher
hotspot_id 必须 热点的HotSpot ID

返回数据示例与说明:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功;如果为以ERR开头的文字,则代表错误 -->
        <code>OK</code>
        <!-- message: 调用结果状态说明(供调试参考)-->
        <message>Operation Completed</message>
    </status>
    <data> <!-- 仅在code为OK时出现 -->
        <record> <!-- 每个record标签代表一条电子招待券记录 -->
            <voucher_id>9</voucher_id> <!-- 电子招待券的唯一存储标识 -->
            <voucher>123</voucher> <!-- 电子招待券文本。如果是多个电子招待券,则以“;”间隔 -->
            <onceonly>0</onceonly> <!-- 1代表仅可使用一次;0代表不限制;2代表仅可使用一次且已使用过 -->
            <minute>30</minute> <!-- 使用时长(分钟) -->
            <end_time></end_time> <!-- 截止时间 -->
            <expiretime></expiretime> <!-- 有效期 -->
            <client_num>0</client_num> <!-- 最大用户数。0代表不限制 -->
        </record>
    </data>
</result>

5.7 添加电子招待券
请求参数说明:

参数名 必须/可选 默认值 最大长度(Bytes) 说明
command 必须 固定值:add_voucher
hotspot_id 必须 热点的HotSpot ID
voucher 必须 电子招待券文本
如果是多个电子招待券,则以“;”间隔
最多不可超过1000个电子招待券
每个电子招待券长度不可超过30字节,仅限英文或数字
onceonly 可选 0 1 1代表仅可使用一次;0代表不限制
minute 可选 11 使用时长(分钟)
end_time 可选 截止时间。格式必须是“2012-03-05 09:02:00”
expiretime 可选 有效期。格式必须是“2012-03-05 09:02:00”
client_num 可选 0 最大用户数。0代表无限制。

*注:minute和end_time,二者只能同时有一个生效,因此只可设置其一。

返回数据示例与说明:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功;如果为以ERR开头的文字,则代表错误 -->
        <code>OK</code>
        <!-- message: 调用结果状态说明(供调试参考)-->
        <message>Voucher Created</message>
    </status>
</result>

5.8 修改电子招待券
请求参数说明:

参数名 必须/可选 默认值 最大长度(Bytes) 说明
command 必须 固定值:change_voucher
hotspot_id 必须 热点的HotSpot ID
voucher 必须 电子招待券文本
如果是多个电子招待券,则以“;”间隔
每个电子招待券长度不可超过30字节,仅限英文或数字
onceonly 可选 0 1 1代表仅可使用一次;0代表不限制
minute 可选 11 使用时长(分钟)
end_time 可选 截止时间。格式必须是“2012-03-05 09:02:00”
expiretime 可选 有效期。格式必须是“2012-03-05 09:02:00”
client_num 可选 0 最大用户数。0代表无限制。

*注:minute和end_time,二者只能同时有一个生效,因此只可设置其一。

返回数据示例与说明:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功;如果为以ERR开头的文字,则代表错误 -->
        <code>OK</code>
        <!-- message: 调用结果状态说明(供调试参考)-->
        <message>Voucher Changed</message>
    </status>
</result>

5.9 删除电子招待券
请求参数说明:

参数名 必须/可选 说明
command 必须 固定值:delete_voucher
voucher_id 必须 电子招待券存储标识。如果是多个,则以“;”间隔

返回数据示例与说明:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功;如果为以ERR开头的文字,则代表错误 -->
        <code>OK</code>
        <!-- message: 调用结果状态说明(供调试参考)-->
        <message>Voucher Deleted</message>
    </status>
</result>

或者,可按以下方式
请求参数说明:

参数名 必须/可选 说明
command 必须 固定值:delete_voucher_by_name
hotspot_id 必须 热点的Hotspot ID
voucher 必须 电子招待券文本。如果是多个,则以“;”间隔

返回数据示例与说明:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功;如果为以ERR开头的文字,则代表错误 -->
        <code>OK</code>
        <!-- message: 调用结果状态说明(供调试参考)-->
        <message>Voucher Deleted</message>
    </status>
</result>

5.10 删除全部电子招待券
请求参数说明:

参数名 必须/可选 说明
command 必须 固定值:delete_all_vouchers
hotspot_id 必须 热点的HotSpot ID

返回数据示例与说明:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功;如果为以ERR开头的文字,则代表错误 -->
        <code>OK</code>
        <!-- message: 调用结果状态说明(供调试参考)-->
        <message>All Vouchers Deleted</message>
    </status>
</result>

5.11 查询访问控制规则
请求参数说明:

参数名 必须/可选 说明
command 必须 固定值:list_mac
hotspot_id 必须 热点的HotSpot ID

返回数据示例与说明:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功;如果为以ERR开头的文字,则代表错误 -->
        <code>OK</code>
        <!-- message: 调用结果状态说明(供调试参考)-->
        <message>Operation Completed</message>
</status>
    <data> <!-- 仅在code为OK时出现 -->
        <record> <!-- 每个record标签代表一条访问控制规则记录 -->
            <mac_id>224</mac_id> <!-- 访问控制记录的唯一存储标识 -->
            <mac>00:50:56:C0:00:08</mac> <!-- MAC地址 -->
            <action>1</action> <!-- 控制规则。0代表屏蔽;1代表放行;2代表免认证 -->
            <memo>Hello, world!</memo> <!-- 备注信息 -->
        </record>
    </data>
</result>

5.12 添加访问控制规则
请求参数说明:

参数名 必须/可选 默认值 最大长度(Bytes) 说明
command 必须 固定值:add_mac
hotspot_id 必须 热点的HotSpot ID
mac 必须 30 MAC地址
action 必须 1 控制规则。0代表屏蔽;1代表放行;2代表免认证
memo 可选 255 备注信息

返回数据示例与说明:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功;如果为以ERR开头的文字,则代表错误 -->
        <code>OK</code>
        <!-- message: 调用结果状态说明(供调试参考)-->
        <message>MAC Added</message>
    </status>
</result>

5.13 修改访问控制规则
请求参数说明:

参数名 必须/可选 默认值 最大长度(Bytes) 说明
command 必须 固定值:change_mac
hotspot_id 必须 热点的HotSpot ID
mac_id 必须 访问控制记录的存储标识
mac 必须 30 MAC地址
action 必须 1 控制规则。0代表屏蔽;1代表放行;2代表免认证
memo 可选 255 备注信息

返回数据示例与说明:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功;如果为以ERR开头的文字,则代表错误 -->
        <code>OK</code>
        <!-- message: 调用结果状态说明(供调试参考)-->
        <message>MAC Changed</message>
    </status>
</result>

5.14 删除访问控制规则
请求参数说明:

参数名 必须/可选 说明
command 必须 固定值:delete_mac
hotspot_id 必须 热点的HotSpot ID
mac_id 必须 访问控制记录的存储标识

返回数据示例与说明:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功;如果为以ERR开头的文字,则代表错误 -->
        <code>OK</code>
        <!-- message: 调用结果状态说明(供调试参考)-->
        <message>MAC Deleted</message>
    </status>
</result>

5.15 获取插播广告功能状态
请求参数说明:

参数名 必须/可选 说明
command 必须 固定值:get_inj_ad_status
hotspot_id 必须 热点的HotSpot ID

返回数据示例与说明:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功;如果为以ERR开头的文字,则代表错误 -->
        <code>OK</code>
        <!-- message: 调用结果状态说明(供调试参考)-->
        <message>Query Completed</message>
</status>
    <data> <!-- 仅在code为OK时出现 -->
        <inj_ad_flag>1</inj_ad_flag> <!-- 启用插播广告功能标识。1代表启用,0代表禁用。注:变更后约10分钟生效。 -->
        <interval>10</interval> <!-- 广告关闭后再次显示间隔(分钟) -->
    </data>
</result>

5.16 修改插播广告功能状态
请求参数说明:

参数名 必须/可选 说明
command 必须 固定值:change_inj_ad_status
hotspot_id 必须 热点的HotSpot ID
inj_ad_flag 可选 启用插播广告功能标识。1代表启用,0代表禁用。
注:变更后约10分钟生效。
interval 可选 广告关闭后再次显示间隔(分钟)

返回数据示例与说明:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功;如果为以ERR开头的文字,则代表错误 -->
        <code>OK</code>
        <!-- message: 调用结果状态说明(供调试参考)-->
        <message>AD Status Changed</message>
</status>
</result>

5.17 获取所有插播广告
请求参数说明:

参数名 必须/可选 说明
command 必须 固定值:list_inj_ad
hotspot_id 必须 热点的HotSpot ID

返回数据示例与说明:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功;如果为以ERR开头的文字,则代表错误 -->
        <code>OK</code>
        <!-- message: 调用结果状态说明(供调试参考)-->
        <message>Operation Completed</message>
    </status>
  <data> <!-- 仅在code为OK时出现 -->
      <record> <!-- 每个record标签代表一条热点信息记录 -->
          <ad_id>3568</ad_id> <!-- 广告ID -->
          <position>0</position> <!-- 展示位置。0:右下角,1:下方居中,2:左下角,3:右上角,4:上方居中,5:左上角,6:页面正中。 -->
          <img_url>http://www.abc.com/img/hello.jpg</img_url> <!-- 广告图片的URL -->
          <width></width> <!-- 广告图片的宽度 -->
          <height></height> <!-- 广告图片的高度 -->
          <url_txt>baidu.com wiwiz.com</url_txt> <!-- 页面URL触发关键字 -->
          <title_txt>iPhone iPad PC</title_txt> <!-- 页面标题触发关键字 -->
          <ua_txt>Android iPhone Mobile</ua_txt> <!-- 浏览器标识(User Agent)触发关键字 -->
          <b_url_txt>google.com</b_url_txt> <!-- 页面URL不触发关键字 -->
          <b_title_txt>Fire</b_title_txt> <!-- 页面标题不触发关键字 -->
          <b_ua_txt>Windows</b_ua_txt> <!-- 浏览器标识(User Agent)不触发关键字 -->
          <click_url>http://www.abc.com</click_url> <!-- 跳转网址 -->
          <remarks>广告一</remarks> <!-- 备注 -->
          <valid>1</valid> <!-- 启用标识。1:启用,0:禁用 -->
          <close_on_click>1</close_on_click> <!-- 点击后隐藏广告标识。1:启用,0:禁用 -->
      </record>
  </data>
</result>

5.18 添加插播广告
请求参数说明:

参数名 必须/可选 默认值 最大长度(Bytes) 说明
command 必须 固定值:add_inj_ad
hotspot_id 必须 热点的HotSpot ID
img_url 必须 255 广告图片的URL
width 可选 广告图片的宽度。必须是数字
height 可选 广告图片的高度。必须是数字
position 必须 0 1 展示位置。
0:右下角,1:下方居中,2:左下角,3:右上角,4:上方居中,5:左上角,6:页面正中。
close_on_click 必须 1 1 点击后隐藏广告。1:是,0:否。
click_url 可选 255 跳转网址
url_txt 可选 255 触发网址关键字。如设置多个,以半角空格间隔。
title_txt 可选 255 触发标题关键字。如设置多个,以半角空格间隔。
ua_txt 可选 255 触发浏览器标识关键字。如设置多个,以半角空格间隔。
b_url_txt 可选 255 不触发网址关键字。如设置多个,以半角空格间隔。
b_title_txt 可选 255 不触发标题关键字。如设置多个,以半角空格间隔。
b_ua_txt 可选 255 不触发浏览器标识关键字。如设置多个,以半角空格间隔。
valid 必须 1 1 启用标识。1:启用,0:禁用。
remarks 可选 255 备注信息

返回数据示例与说明:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功;如果为以ERR开头的文字,则代表错误 -->
        <code>OK</code>
        <!-- message: 调用结果状态说明(供调试参考)-->
        <message>AD Added</message>
</status>
</result>

5.19 修改插播广告
请求参数说明:

参数名 必须/可选 默认值 最大长度(Bytes) 说明
command 必须 固定值:change_inj_ad
hotspot_id 必须 热点的HotSpot ID
ad_id 必须 广告ID
img_url 必须 255 广告图片的URL
width 可选 广告图片的宽度。必须是数字
height 可选 广告图片的高度。必须是数字
position 必须 0 1 展示位置。
0:右下角,1:下方居中,2:左下角,3:右上角,4:上方居中,5:左上角,6:页面正中。
close_on_click 必须 1 1 点击后隐藏广告。1:是,0:否。
click_url 可选 255 跳转网址
url_txt 可选 255 触发网址关键字。如设置多个,以半角空格间隔。
title_txt 可选 255 触发标题关键字。如设置多个,以半角空格间隔。
ua_txt 可选 255 触发浏览器标识关键字。如设置多个,以半角空格间隔。
b_url_txt 可选 255 不触发网址关键字。如设置多个,以半角空格间隔。
b_title_txt 可选 255 不触发标题关键字。如设置多个,以半角空格间隔。
b_ua_txt 可选 255 不触发浏览器标识关键字。如设置多个,以半角空格间隔。
valid 必须 1 1 启用标识。1:启用,0:禁用。
remarks 可选 255 备注信息

返回数据示例与说明:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功;如果为以ERR开头的文字,则代表错误 -->
        <code>OK</code>
        <!-- message: 调用结果状态说明(供调试参考)-->
        <message>AD Changed</message>
</status>
</result>

5.20 删除插播广告
请求参数说明:

参数名 必须/可选 说明
command 必须 固定值:delete_inj_ad
hotspot_id 必须 热点的HotSpot ID
ad_id 必须 广告ID

返回数据示例与说明:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功;如果为以ERR开头的文字,则代表错误 -->
        <code>OK</code>
        <!-- message: 调用结果状态说明(供调试参考)-->
        <message>AD Deleted</message>
</status>
</result>



6. 注解
注1:调用结果状态码说明

OK 调用成功
ERR50000 需升级至Wiwiz专业版
ERR50001 User Key或sign错误
ERR50002 参数值非法
ERR50003 参数值不可为空
ERR50004 至少需要设定一个费率
ERR50005 如果isfree设定为1,那么auth_login必须为1,且logintype必须为0
ERR50006 如果auth_login为1且logintype为1,那么isfree必须为0
ERR50010 HotSpot ID错误
ERR50011 超过热点最大数限制
ERR50013 超过电子招待券最大数限制(10000个)
ERR50014 MAC地址重复

注2:时区
Etc/GMT+0
Etc/GMT+1
Etc/GMT+10
Etc/GMT+11
Etc/GMT+12
Etc/GMT+2
Etc/GMT+3
Etc/GMT+4
Etc/GMT+5
Etc/GMT+6
Etc/GMT+7
Etc/GMT+8
Etc/GMT+9
Etc/GMT-0
Etc/GMT-1
Etc/GMT-10
Etc/GMT-11
Etc/GMT-12
Etc/GMT-13
Etc/GMT-14
Etc/GMT-2
Etc/GMT-3
Etc/GMT-4
Etc/GMT-5
Etc/GMT-6
Etc/GMT-7
Etc/GMT-8
Etc/GMT-9
*注意,时区格式为POSIX风格,例如Etc/GMT-8实际代表的是GMT+8:00

注3:国家地区(代码:含义)
AR:阿根廷
AT:奥地利
AU:澳大利亚
BE:比利时
BR:巴西
CA:加拿大
CH:瑞士
CN:中国
DE:德国
DK:丹麦
ES:西班牙
FR:法国
GB:英国
HK:中国香港特别行政区
ID:印度尼西亚
IE:爱尔兰
IL:以色列
IN:印度
IT:意大利
JO:约旦
JP:日本
KR:韩国
KY:开曼群岛
LU:卢森堡
MO:中国澳门特别行政区
MX:墨西哥
MY:马来西亚
NL:荷兰
NO:挪威
NZ:新西兰
PH:菲律宾
PK:巴基斯坦
PL:波兰
SE:瑞典
SG:新加坡
TH:泰国
TR:土耳其
TW:台湾
US:美国
ZA:南非

注4:币种
USD: 美元
EUR: 欧元
JPY: 日元
HKD: 港币
CNY: 人民币

Comments are closed.