企业微信创建实例(步骤一) API
「创建实例(步骤一)」接口属于青鸾开放平台的「实例与登录」能力,用于企业微信账号的接入、一键扫码登录、保活、恢复与在线状态管理。通过语义化 HTTP API 调用,无需对接复杂底层即可快速集成,常用于 SCRM、客服系统、私域运营与营销自动化等场景。
免费试用本接口 查看完整文档接口地址
POSThttps://api.qingluanbot.com/wecom/instances/create-client
请求示例(cURL)
curl -X POST 'https://api.qingluanbot.com/wecom/instances/create-client' \
-H 'X-Qingluan-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"instance_guid": "inst_xxxxxxxxxxxxxxxx",
"proxyUrl": "https://example.com",
"areaCode": 0,
"deviceName": "示例值",
"deviceType": 0,
"clientVersion": "示例值"
}'
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
instance_guid | string | 必填 | 青鸾实例 ID(标识一个企业微信在线实例) |
proxyUrl | string | 必填 | 格式必须为:socks5://user:pass@127.0.0.12:8080,目前只支持socks5。如无sk5代理请使用地区ID |
areaCode | integer | 必填 | 地区id对照表 110000:北京市 | 120000:天津市 | 130000:河北省 | 140000:山西省 | 210000:辽宁省 | 220000:吉林省 | 230000:黑龙江省 |310000:上海市 | 320000 :江苏省 | 330000:浙江省 | 340000:安徽省 | 350000:福建省 | 360000:江西省 | 370000:山东省 | 410000:河南省 | 420000:湖北省 | 430000:湖南省 | 440000:广东省 | 450000:广西省 | 460000:海南省 | 500000:重庆市 | 510000:四川省 | 520000:贵州省 | 530000:云南省 | 540000:西藏 | 610000:陕西省 | 620000:甘肃省 | 630000:青海省 | 640000:宁夏 | 150000:内蒙古 | 650000:新疆 | |
deviceName | string | 必填 | 实例名称 |
deviceType | integer | 必填 | 非必须,0-ipad, 2-windows(默认为ipad,目前支持ipad,windows) |
clientVersion | string | 可选 | 实例版本号 |
响应
统一响应信封 { ok, code, message, request_id, data },code=0 表示成功,每次响应都带 request_id(ql_ 前缀)便于排查。
如何接入
- 注册并登录青鸾开发者控制台(注册即自动生成 API Key)。
- 在「实例与回调」一键扫码上号,获得
instance_guid。 - 请求头携带
X-Qingluan-Key,调用本接口POST /wecom/instances/create-client。 - 如需接收消息/事件,配置 Webhook 回调地址即可。