QQ机器人文档

QQ 呆板人 简介

QQ 呆板人通过开放的平台承载呆板人的定制化罪能，让开发者与得更干脆痛快酣畅的开发体验。

亮点

便利：通过开放接口的模式，QQ 开放平台允许开发者停行呆板人定制化开发。

高效：供给一淘范例化、易接入的API取websocket变乱，可以协助开发者真现呆板人的快捷开发和迭代。

兴趣：呆板人翻新 C 端交互方式，通过指令的方式承载效劳，让多样化效劳变得触手可达。

赋能：频道、群、单聊等QQ场景片面打通，深度融入QQ社交生态，用户根原大，效劳领域广。

接入流程

1. 浏览文档

为了更高效的进驻到 QQ 呆板人平台，倡议先浏览下列文档后再启动进驻工做：

经营标准 | QQ呆板人文档

开发注明 | QQ呆板人文档

2. 企业主体入驻

企业主体入驻开发者默许撑持频道、群场景开发才华；个人主体入驻开发者默许仅撑持频道场景开发才华。除默许开明的才华外，后续其余接口才华申请上，企业开发者取个人开发者也存正在不同。

轨范总览

留心

企业入驻须要供给工商信息，蕴含：营业执照、对公账号，如不具备的用户请前往个人入口停行入驻。 邮箱一旦填写完结进入激活轨范，则被占用，不成批改，所以选错主体类型的用户须要改换邮箱从头注册。

2.1 点击「立刻注册」

安详提示

效劳的三个类目，将鼠标放上去，将会有相关使用的文档及对应便利入口，正在注册前可先浏览相关文档。

2.2 选择企业

2.3 填写邮箱

安详提示

之前曾经注册过的邮箱不需再注册，间接去登陆界面登陆便可。

2.4 激活邮箱

安详提示

如未支到邮件，请检查垃圾箱大概点击从头发送停行检验测验。

2.5 上传工商信息

安详提示

请务必确认上传的营业执照取填写的主体信息保持一致，账号注册完结，后续还存正在其余主体认证轨范，信息纷比方致将会招致后续轨范显现问题。

2.6 绑定打点员

安详提示

姓名和身份证号码务必取手机号码对应经营商真名登记的信息一致，否则会提示舛错。

2.7 天分审核

打点员绑定完成后账号即注册乐成，进入使用打点页后，需停行后续企业天分审核轨范。

此轨范可取第三步创立使用同步停行，但此轨范需尽快完成，否则会映响使用的提审。

入口：点击页面提示条上的「查察详情」，便可进入详情页面查察进度。

天分审核具体流程

审核中-量料审核：  注册完成即主动进入工商信息审核，此轨范无需开发者收配，但请随时关注形态变更。

审核中-待打款：  填写银止信息，点击查察详情，进入二级页面填写对公账户的银止信息，如系统没有对应【银止所正在地的区】，可选择同市其余区。

审核中-银止打款中：  如银止信息审核无误，则 3 天内腾讯公司将会对填写的对公银止账户停行 1 元以下小额打款，请关注银止支款。

打款帐号主体：深圳市腾讯计较机系统有限公司，打款银止账号：755901658210820。

审核中-校验金额：  支到打款后，请正在规定光阳内于开发者打点端回填支到的打款金额停行验证。

金额校验次数有限，请确认支到打款后进入二级页面，填写详细的金额，如次数用完且校验不通过，该账号将被冻结。

3 个人主体入驻

企业主体入驻开发者默许撑持频道、群场景开发才华；个人主体入驻开发者默许仅撑持频道场景开发才华。除默许开明的才华外，后续其余接口才华申请上，企业开发者取个人开发者也存正在不同。

轨范总览

3.1 点击「立刻注册」

安详提示

效劳的三个类目，将鼠标放上去，将会有相关使用的文档及对应便利入口，正在注册前可先浏览相关文档。

3.2 选择个人

3.3 填写邮箱

安详提示

之前曾经注册过的邮箱不需再注册，间接去登陆界面登陆便可。

3.4 激活邮箱

安详提示

如未支到邮件，请检查垃圾箱大概点击从头发送停行检验测验。

3.6 绑定打点员

安详提示

姓名和身份证号码务必取手机号码对应经营商真名登记的信息一致，否则会提示舛错。

绑定乐成便可进入使用打点页初步创立使用。

4 创立使用

创立呆板人。

4.1 点击「创立呆板人」

4.2 填写量料 4.2.1 呆板人量料填写页面

4.2.2 进入打点端

量料提交乐成后，即会生成appid，点击对应的使用便可跳转打点端。

5. 呆板人发布流程

倡议依照首页发布流程，划分完成呆板人配置、开发、提交审核；审核通过并手动上线后，方可正在QQ客户端添加呆板人至对应场景。

6. 根原信息设置

呆板人创立后初度上线前，正在相关罪能配置提交审核时，呆板人根柢信息将一并提交审核；

呆板人初度上线后，呆板人根柢信息批改将径自提交审核，审核完成前其余模块不成提交审核；

根柢信息批改限制：每月可批改5次。

收配轨范：

（1）点击「批改」进入编辑，完成根原信息批改

（2）点击保存，扫描二维码确认保存

（3）等候审核通过

（4）审核通事后，前往「发布设置」，点击「上线」

7. 开发场景选择

正在沙箱配置页面，差异类型开发者撑持开发差异场景呆板人罪能

可开发的场景取开发者认证身份有关，具体如下：

认证身份 QQ频道 QQ群 音讯列表单聊
企业开发者   ✅   ✅   申请后可开发  
个人开发者   ✅   久不开放   久不开放  
7.1 配置沙箱环境

倡议开发者依据真际的须要，选择正在差异场景开发呆板人，完成对应场景的沙箱环境配置。配置沙箱后，开发者可正在「罪能配置」、「运用领域取人员」页面解锁相应场景的配置才华。

沙箱频道仅可设置当前用户为频道主/打点员的频道、沙箱群仅可设置当前用户为群主/群打点员的群，且沙箱频道成员、沙箱群成员不成大于20人。

安详提示

（1）配置沙箱群/频道，须要先正在QQ客户端创立折乎沙箱要求的QQ群/QQ频道；
（2）正在频道场景，呆板人依然糊口生涯「公域」/「私域」呆板人的区分，设置为公域呆板人保存确认后不成切换为私域呆板人，但正在「运用领域取人员」可设置公域呆板人的允许添加领域：“全副用户可添加”/“仅皂名单用户可添加”；
（3）配置沙箱频道/群后，呆板人会出如今沙箱频道/沙箱群的呆板人列表当中。

7.2 添加呆板人至沙箱环境

配置好沙箱环境后，可通过呆板人量料卡将测试呆板人添加进沙箱频道/沙箱群/沙箱账号，沙箱群/沙箱频道也可通过群/频道设置页的呆板人列表添加呆板人。

7.2.1 添加到沙箱频道

办法一：挪动端点击沙箱频道封面图-->选择「呆板人」进入商店页-->点击添加测试呆板人

办法二：挪动端登陆打点员QQ号-->扫描打点端频道呆板人二维码-->翻开呆板人量料卡-->添加至频道-->选择配置好的沙箱频道-->确认添加

安详提示

二维码可正在「运用领域取人员」页面扫描。

【进入私信沙箱】

沙箱频道添加好测试呆板人后，曾经配置沙箱私信账号的QQ号，从沙箱频道翻开呆板人量料卡，选择私信，即进入私信沙箱环境

安详提示

当账号正在「沙箱配置」-「正在频道私信配置」完成配置后，该账号从任意渠道进入该呆板人的频道私信窗口，拉到的该呆板人指令面板、根原信息量料等内容均为沙箱环境信息。

7.2.2 添加到沙箱群

办法一：挪动端点击沙箱群"设置"-->选择「群呆板人」进入商店页-->点击添加测试呆板人

办法二：挪动端登陆打点员QQ号-->扫描打点端QQ群和音讯列表呆板人二维码-->翻开呆板人web量料卡-->点击「添加到呆板人」-->跳转到natiZZZe量料卡-->分享到沙箱群-->翻开natiZZZe量料卡-->点击「添加到原群」-->选择配置好的沙箱群-->授权确认添加

安详提示

二维码可正在「运用领域取人员」页面扫描

7.2.3 添加到沙箱账号音讯列表

挪动端登陆打点员QQ号-->扫描打点端QQ群和音讯列表呆板人二维码-->翻开呆板人量料卡-->点击"发音讯"-->授权确认添加-->进入音讯列表开启沙箱单聊对话

8. 开发根原设置

获与取配置开发所需信息

8.1 呆板人 AppID

此处次要展示呆板人QQ号、AppID、Token、AppSecret。

安详提示

此信息不要对别流传

8.2 回调地址

正在跳转h5须要OAuth的时候运用 （如呆板人效劳是跳转小步调，可疏忽），回调地址上限为10条。

8.3 音讯URL皂名单配置

填写呆板人下发音讯中所包孕的链接域名，域名需正在此处提交后才可生效，域名上限为20条，每年可批改50次。

安详提示

域名需提早停行 ICP 立案，并通过域名校验才可报备乐成。

8.4 频道用户定见应声

为了协助开发者获与 C 端用户应付呆板人的评估取应声，平台正在频道场景为开发者接入了"兔小巢应声空间"，开发者可以通过创立产品应声空间。

频道用户定见应声： 点击进入登陆后，依据提示创立产品，将会与得一个兔小巢应声空间，C 端用户所填写的呆板人应声将同步至此空间，开发者以后可登陆此空间查察用户应声。

产品ID填写： 须要正在此处填写兔小巢应声空间的产品 ID，C 端用户的呆板人应声才可同步至此处，具体获与途径如开发者端提示：设置-->产品设置-->产品 ID。

安详提示

兔小巢创立取运用详情可点击用户应声空间创立攻略 (opens new window)

8.5 IP皂名单配置

为了防备接口挪用安宁风险，平台将撑持呆板人配置IP皂名单。（当前只针对新删呆板人默许启用ip皂名单，后续会逐渐对旧的呆板人停行灰度）

IP皂名单罪能启用之后，开放平台将会正在正式环境对开发者的陈列IP停行限制：只要皂名单IP威力连贯websocket和挪用OPENAPI的接口。当前IP皂名单只做用于正式环境，不映响呆板人正在沙箱环境的运用。接口域名如下：

获与挪用凭证：hts://bots.qqss/app/getAppAccessToken 不区分正式环境、沙箱环境

正式环境：hts://api.sgroup.qqss/

沙箱环境：hts://sandboV.api.sgroup.qqss 沙箱环境地址只会支到正在开发者平台配置的沙箱频道、沙箱私信QQ号、沙箱群、沙箱单聊QQ号的变乱，且挪用openapi仅能收配沙箱环境

应付新删呆板人，平台默许启用IP皂名单罪能，并限制只要填写了IP皂名单威力提审和上线。

安详提示

IP皂名单宗旨是担保开发者安宁，请配置有效的公网惟一IP。

9. 发布设置

开发者可以通过【发布设置】来配置呆板人指令取效劳，此处配置的指令取效劳将会正在C端指令面板、量料卡等处展示，以便用户取呆板人倏地完成交互，后端逻辑均需通过代码开发真现。

9.1 罪能配置

罪能配置分为效劳配置、指令配置、倏地菜单配置。此中指令面板对应C端频道、群、音讯列表单聊场景下输入框“/”拉起的指令面板，指令面板的效劳取指令正在“效劳配置”、“指令配置”页面划分收配配置；倏地菜单对应C端音讯列表单聊场景下拉起的输入框下的罪能面板，倏地菜单的效劳取指令正在同一页面下收配配置。

9.1.1 效劳配置

音讯列表单聊、群聊、频道笔朱子频道 “/” 指令面板取呆板人量料卡「效劳」所展示的供用户倏地跳转呆板人效劳小步调页面的罪能，开发者需正在打点端配置，可配置罪能上限为24个。

称呼：请简略凝练的形容罪能，字数不赶过8个中笔朱符或 16个英笔朱符，内容需折乎平台经营标准。

引见：请简略的对罪能停行引见，字数不赶过40个中笔朱符或 80个英笔朱符，内容需折乎平台经营标准。

appID：请输入小步调效劳的ID号。

path：请输入小步调的途径。

eVtendData：请输入小步调 eVtendData，目前仅频道场景可用。

权限菜单：请选择原效劳是开放给所有用户还是仅针对频道主和打点员。

运用场景：请选择该指令所需配置的用户场景，蕴含QQ频道、频道私信、QQ群、音讯列表等共四个场景，真际所展示的可配置场景与决于当前呆板人开发者的角涩、所具备的场景权限和沙箱配置形态。

留心

eVtendData仅撑持正在频道场景下开放频道ID、子频道ID，群场景、音讯列表单聊场景久无相关字段开放； 当配置了eVtendData字段且运用场景同时撑持频道及其余场景时，用户正在非频道场景翻开该效劳小步调，频道ID、子频道ID返回为空。

9.1.2 指令配置

音讯列表单聊、群聊、频道笔朱子频道 “/” 指令面板取呆板人量料卡「指令」所展示的供用户倏地输入的指令入口，开发者需正在打点端配置，可配置罪能上限为24个。

指令名：请简略凝练地形容指令，字数不赶过8个中笔朱符或 16个英笔朱符，内容需折乎平台经营标准。

指令引见：请简略的对指令停行形容，字数不赶过15个中笔朱符或30个英笔朱符，内容需折乎平台经营标准。

权限菜单：请选择原指令是开放给所有用户还是仅针对频道主和打点员。

运用场景：请选择该指令所需配置的用户场景，蕴含QQ频道、频道私信、QQ群、音讯列表等共四个场景，真际所展示的可配置场景与决于当前呆板人开发者的角涩、所具备的场景权限和沙箱配置形态。

开发者可添加、增减指令，打点端配置的罪能顺序取 C 端呆板人指令集展示的罪能顺序一致，倡议将罕用/焦点的指令前置。

9.1.3 倏地菜单

效劳

开发者需正在打点端配置用于 C 实个音讯列表单聊场景倏地菜单的小步调效劳，可配置罪能上限为12个。

称呼：请简略凝练的形容罪能，字数不赶过8个中笔朱符或 16个英笔朱符，内容需折乎平台经营标准。

引见：请简略的对罪能停行引见，字数不赶过40个中笔朱符或 80个英笔朱符，内容需折乎平台经营标准。

appID：请输入小步调效劳的ID号。

path：请输入小步调的途径。

指令

开发者需正在打点端配置用于 C 实个音讯列表单聊场景倏地菜单的罪能指令，可配置罪能上限为12个。

指令名：请简略凝练地形容指令，字数不赶过8个中笔朱符或 16个英笔朱符，内容需折乎平台经营标准。

指令引见：请简略的对指令停行形容，字数不赶过15个中笔朱符或30个英笔朱符，内容需折乎平台经营标准。

留心

指令、效劳和倏地菜单模块久不须要径自提审，自测完成后，填写自测报告取自测报告一起提审。

9.2 自测报告

开发者需下载呆板人自测报告模版，正在自测频道内依据模板要求测试呆板人的罪能，并填写完自测报告后上传。

10. 运用领域取人员配置

开发者可依据呆板人真际经营须要控制可添加呆板人至频道、群、音讯列表单聊的领域。

呆板人初度上线前，开发者可配置各场景下呆板人运用领域为"全质"/"皂名单"，切换为皂名单后需等候呆板人完成初度上线审核前方可配置添加皂名单。

呆板人初度上线后，运用领域的从"全质"切换为"皂名单"无需等候审核结果，立刻生效；运用领域从"皂名单"切换为"全质"时须要等候审核结果。

审核结果返回前，不成重复提交审核。

频道皂名单、群皂名单、音讯列表单聊用户皂名单上限各20条。

安详提示

将频道/群/音讯列表单聊的运用领域设置为全质，即允许全副频道/群/用户通过呆板人量料卡添加该呆板人，开发者可将呆板人量料卡通过链接、二维码等模式分享给频道主/群主/打点员、用户停行呆板人添加

频道/群/音讯列表单聊的运用领域设置为皂名单，即仅允许皂名单内频道的频道主/打点员、群的群主/打点员、用户通过量料卡添加该呆板人至对应频道群、音讯列表单聊；

将指定频道、群、用户从皂名单增除后，其真不会正在C端移除呆板人取该频道、群、用户的干系链，但正在QQ客户端收配呆板人移除后，无奈再通过呆板人量料卡添加该呆板人，并可能映响呆板人正在该干系链场景的音讯对话效劳。

11. 成员打点 11.1 角涩

开发者打点实个角涩共有两种：打点员和普通成员。

打点员 ：撑持批改，但仅打点员自己可收配

普通成员 ：可添加最大限度为50人

11.2 权限

登陆权限 ：领有该权限的成员可登陆和查察开发者打点端信息，但不成编辑。

发布权限 ：领有该权限的成员可编辑和提交效劳、指令等模块。

开发设置 ：领有该权限的成员可编辑和提交回调地址、URL 模块。

安详提示

登陆权限是根原权限，要领有发布权限和开发权限的前提是领有登陆权限

12. 高阶罪能 12.1 根原音讯罪能

【音讯类型】呆板人发送音讯分为自动音讯和被动音讯：

被动音讯 ：严格的 AB 对话模式（用户艾特呆板人发送 A，呆板人回复 B），被动音讯有效期为5分钟。

自动音讯 ：自动触发类型的音讯，满足条件呆板人自动发送（如按时揭示），自动音讯无需正在打点者平台停行上传审核。

【自动音讯限制 】

自动音讯每日每个频道限制发送20条，且仅允许正在2个子频道下发自动音讯。

久不开放"入群接待语"效劳。

监听变乱"当呆板人被添加进频道"后，限制呆板人仅正在1个子频道内下发自动音讯。

普通音讯不撑持图文+文原，如需配置图文+文原，可运用ark音讯真现。

12.2 Markdown才华申请

审核周期： 每月15-20日统一审核，审核结果会停行邮件通知。

呆板人平台联络邮箱：QQ_Bot_API@Tencentss