当前打开的是本地文件,浏览器会阻止带凭证的跨域请求。请使用线上 Cloudswagger进行接口调试。
Protocol workspace

稳定接入,
安全运行。

公开查看 Cloud API;注册工作区、连接微信并获取节点 Access Token 后,即可按文档调试接口。第一次使用请从下方四步开始。

稳定会话签名鉴权绑定会话调用
Start with Cloud

从注册到第一次调用

API 文档无需登录即可阅读。真正调用接口前,先在 Cloud 工作区完成微信连接并取得对应节点的凭证。

STEP 01

注册 Cloud 账号

免费创建账号并进入工作区;已有账号可以直接登录。

创建账号 →
STEP 02

连接微信节点

在节点工作台按引导选择登录设备和网络出口,用手机扫码完成连接。

打开节点工作台 →
STEP 03

取得节点凭证

在节点工作台复制该微信的 Access Token;管理工作区时使用独立的管理密钥。

查看 API 凭证 →
STEP 04

调试第一个接口

在下方接口目录选择只读接口,设置对应凭证并发送测试请求。

浏览接口目录 →
工作区页面需要登录;这里的公共文档可分享给开发人员。API 请求仍由服务端校验凭证,公开文档不会授予调用权限。
Product Capabilities

从安全接入到稳定运行,一套完成

模块化接口、统一鉴权与运行监控,让开发、联调和交付保持一致。

01 · SESSION

稳定管理登录与会话状态

覆盖扫码登录、会话缓存、心跳维护与状态检查。

02 · SESSION ROUTING

绑定会话统一调用

消息、联系人和搜索等业务接口直接使用已绑定账号的登录态,调用方无需手动选择设备类型;设备专用接口会单独标注适用范围。

03 · MESSAGE

消息能力

发送、同步与实时事件统一接入。

04 · CONTENT

内容服务

搜索、公众号、小程序与内容能力。

稳定与安全,落实到每一次连接从身份登记、请求验证到在线状态形成完整运行链路。
会话路由服务端按绑定账号执行对应协议
签名请求时间戳、随机数与设备密钥校验
凭证隔离TokenKey 与 Access Token 分层管理
运行租约限制重复运行并持续上报状态
XiaoWei Business API

小微业务能力

覆盖资格权限、好友邀请、红点、历史记忆、会话推荐、用户卡片和实时对话。接口直接使用当前绑定账号,响应保持可读业务字段;具体方法统一收录在下方接口目录。

21 个业务接口实时对话 SSE统一业务响应
查看下方接口目录
Quick Start

Cloud REST 接口调用

先在 节点工作台连接微信并取得 Access Token,再按下方 OpenAPI 文档调用对应接口。工作区管理密钥与节点 Access Token 分开使用。

ENDPOINTS
REST  POST /v1/Login/GetCacheInfo
X-Cloud-Access-Token: CLOUD_ACCESS_TOKEN

NEXT  POST /v1/Login/CheckQR?uuid=UUID
X-Cloud-Access-Token: CLOUD_ACCESS_TOKEN
Pad Face Verification

人脸验证,不再单独启动代理

服务器已自动托管人脸代理。先安装服务器 CA,再给人脸验证设备设置 18080 代理,授权扫码手机保持等待。

PAD FACE
证书  /wechatpadpro-ca.cer
代理  正在读取当前服务器配置
API   正在读取当前服务器地址

查看完整步骤
WS

实时消息连接

浏览器先用 Access Token 换取一次性短时票据,再建立同步通道;长期凭证不会出现在连接地址中。

等待连接
推荐方式:Cloud 调用使用每个微信独立的 X-Cloud-Access-Token;WebSocket 票据由 Cloud Gateway 负责签发。
连接地址将在这里生成
消息控制台
Cloud API Reference

Cloud 接口目录

Cloud REST 接口按 Access Token 隔离微信节点;参数、请求体和调用顺序由同一份 OpenAPI 合同提供,填写后可直接切换语言生成调用代码。

12 种代码示例REST /v1