企业 WPA OpenAPI

腾讯企业 WPA OpenAPI 文档

腾讯科技（深圳）有限公司

版权所有 侵权必究

1

企业 WPA OpenAPI

修订记录

日期 修订版本 修改描述 作者 审核

2013.04.10 1.0 正式对外开放

2

企业 WPA OpenAPI

目录

修订记录 .................................................................................................................................................. 2

目录.......................................................................................................................................................... 3

1、资源文件引用.................................................................................................................................... 4

2、相关 API 及参数............................................................................................................................... 4

2.1 BIZQQWPA.ADD .......................................................................................................................... 4

2.1.1 添加单个 WPA .......................................................................................................................... 5

2.1.2 批量接口，一次性增加多个 WPA .......................................................................................... 6

2.2 BIZQQWPA.ADDCUSTOM ............................................................................................................ 9

2.2.1 定制单个 WPA .......................................................................................................................... 9

2.2.2 添加多个定制的 WPA ............................................................................................................ 10

2.3 BIZQQWPA.VISITOR ................................................................................................................... 11

3

企业 WPA OpenAPI

1、资源文件引用

资源文件引用： http:\/\/wpa.b.qq.com\/cgi\/wpa.php

注：请在调用接口前引用该文件

e.g.

<script charset=”utf-8” src=”http:\/\/wpa.b.qq.com\/cgi\/wpa.php”><\/script>

2、相关 API 及参数

2.1 BizQQWPA.add

添加默认外观的 WPA

{Object|Object[]} opts 单个或批量的 WPA 参数

{String} [opts.type=“10”] WPA 的样式类型，1-按钮型，2-匿名聊天，10~12-浮动型(如图1所示)

{String} opts.nameAccount 必选参数，营销 QQ 号码

{String} [opts.parent=document.body] 指定 WPA 在页面中的父元素，默认值为 document.body

注：该参数 parent 仅在 type 参数为1（按钮型）或2（匿名聊天型）时生效

{String} [opts.aty] 接入类型，0-自动分流，1-指定工号，2-指定分组

{String} [opts.a] 指定接入者，aty=0时无效，1时表示指定的工号，2时表示指定的分组

{String} [opts.title] WPA's 的标题文字，仅在 type=11时有效

{String} [opts.wd] WPA 的子标题，type=11时最多输入10个字，type=12时最多输入8个字

{String} [opts.wd2] WPA 的内容文字，仅在 type=11和12时有效，最多16个字

{String} [opts.fsty] 浮动类型，1-固定型，2-滚动型，仅在 type=10,11,12时有效

{String} [opts.fposX] 浮动横向位置，0-左，1-中，2-右，仅在 type=10,11,12时有效

4

企业 WPA OpenAPI

{String} [opts.fposY] 浮动纵向位置，0-上，1-中，2-下，仅在 type=10,11,12时有效

e.g.

图 1 各种风格的默认 wpa 样式

2.1.1 添加单个 WPA

BizQQWPA.add({

aty: '1', \/\/接入到指定工号

a: '1001', \/\/指定工号1001接入

type: '1', \/\/使用按钮类型 WPA

nameAccount: '938060809', \/\/营销 QQ 号码

parent: 'testAdd' \/\/将 WPA 放置在 ID 为 testAdd 的元素里

});

5

企业 WPA OpenAPI

2.1.2 批量接口，一次性增加多个 WPA

BizQQWPA.add([{

aty: '1',

a: '1001',

type: '1',

nameAccount: '938060809',

ws: 'www.meilifang.net',

title: '欢迎咨询我',

parent: 'testAdd'

},

{

aty: '1',

a: '1001',

type: '2',

nameAccount: '938060809',

ws: 'www.meilifang.net',

title: '欢迎咨询我',

6

企业 WPA OpenAPI

parent: 'testAdd2'

},

{

aty: '1',

a: '1001',

type: '10',

nameAccount: '938060809',

ws: 'www.meilifang.net',

title: '欢迎咨询我',

parent: 'testAdd'

},{

aty: '1',

a: '1001',

type: '12',

nameAccount: '938060809',

ws: 'www.meilifang.net',

title: '欢迎咨询我'

7

企业 WPA OpenAPI

},{

aty: '1',

a: '1001',

type: '11',

nameAccount: '938060809',

ws: 'www.meilifang.net',

title: '欢迎咨询我',

wd: 'wording 1',

wd2: 'wording 2'

},{

aty: '1',

a: '1001',

type: '1',

nameAccount: '938060809',

ws: 'www.meilifang.net',

title: '欢迎咨询我',

parent: 'testAddImg',

8

企业 WPA OpenAPI

wd: 'wording 1',

wd2: 'wording 2'

}

]);

2.2 BizQQWPA.addCustom

增加自定义外观的 WPA

{Object|Object[]} opts 单个或批量的 WPA 参数

{String} opts.nameAccount 必选参数，营销 QQ 号码

{String} [opts.node=document.body] 指定要成为 WPA 的元素

{String} [opts.selector] 指定要成为 WPA 的元素的 ID

注：node 和 selector 参数二选一即可，但两者必选其一。两者都填时以 node 为准

{String} [opts.aty] 接入类型，0-自动分流，1-指定工号，2-指定分组

{String} [opts.a] 指定接入者，aty=0时无效，1时表示指定的工号，2时表示指定的分组

e.g.

2.2.1 定制单个 WPA

BizQQWPA.addCustom({

aty: '1', \/\/指定工号类型

a: '1001', \/\/指定的工号

9

企业 WPA OpenAPI

nameAccount: '938060809', \/\/营销 QQ 号码

node: document.body \/\/WPA 被放置的元素

});

2.2.2 添加多个定制的 WPA

BizQQWPA.addCustom([{

aty: '1', \/\/指定工号类型

a: '1001', \/\/指定的工号

nameAccount: '938060809', \/\/营销 QQ 号码

node: document.body \/\/WPA 被放置的元素

}, {

aty: '1',

a: '2',

nameAccount: '938060809',

selector: 'id'

}

]);

10

企业 WPA OpenAPI

2.3 BizQQWPA.visitor

为页面添加访客功能（主动、自动邀请，TA 统计等，如图2、3所示）

{Object} opts 仅支持单个参数

{String} opts.nameAccount 营销 QQ 号码

e.g.

BizQQWPA.visitor({

nameAccount: '938060809'

});

图 2 后台访客邀请功能

图 3 后台 TA 统计数据展示

11