入门指导

概述

WhatsApp 开放 API 提供了一套完整的 WhatsApp Business API 接入能力,支持手机号管理、模板管理、消息发送、WABA 信息查询等功能。

先决条件:需要在JoinMC完成WABA账号申请,公司完成认证与账号状态正常,才能发送消息。申请WABA等操作指导可以查看帮助文档:https://www.kdocs.cn/l/cuxBnjmOoEtD

基础信息

  • Base URL: https://cn.joinmc.cn/api/open/v1
  • 认证方式: 请求头 X-API-Key: {your_secret_key}(从 JoinMC打开社交账号页面选择WhatsApp页签,点击页面右上角的API设置按钮后获取
  • Content-Type: application/json
  • 响应格式: JSON

通用响应结构

{
  “code”: 1,
  “msg”: “OK”,
  “data”: {  }
}

字段类型注释
codeint1-成功,0-失败,400-参数错误,401-认证失败,403-无权限,404-未找到
msgstring提示信息
dataobject/array返回数据

错误码说明

字段类型注释
1int成功
0int业务失败
400int参数错误
401int认证失败(API Key无效或缺失)
403int无权限访问该资源
404int资源未找到(WABA或手机号不存在)

注意事项

  1. 所有接口均需通过 X-API-Key 请求头认证,密钥从 JoinMC后台获取。
  2. 手机号列表接口会自动从 WhatsApp 官方同步最新数据。
  3. 模板列表接口会自动同步最新模板数据到本地库。
  4. 发送模板消息时,系统会自动判断是否收费并记录消费。
  5. 接口访问频率请合理控制,避免触发 WhatsApp 官方限制。

demo文件:demo py文件 请用python执