短信从您自己的手机发出。了解工作原理
石窟画API 第一种架构安全设备配对交付可见度多设备控制已版本文件
开发者枢纽/WhatsAppAPI API 密码

WA · 9 已提供文档的接口操作

WhatsAppAPI 文档

发送WhatsApp消息与媒体,重试失败,验证收件人号码,并在明确同步请求后安全地取回接收到的消息.

连接电话,同步交谈和媒体
REST 基础 URLhttps://api.smsmobileapi.com

· ZXX-10Z 答复 · ZX-11XZS 需要 · UTF-8

连接您的 API 密钥

连接一次,然后测试端点跨越短消息,电话,通知,WhatsApp和电子邮件.

从这里开始

你的第一个要求,分四步走

1

连接并启用一个支持的移动的WhatsApp.

2

以数字检查的终点确认接收者。

3

发去Walex=是。

4

要检索收到的消息: 激活收集, 调用/getwa/同步/, 等待恢复, 然后调用/getwa.

检索收到的信息之前必须

请先同步WhatsApp 。

打电话之前/getwa查看收到的WhatsApp信件,您必须请求同步窗口通过https://api.smsmobileapi.com/getwa/synchronisation/. 。这一明确步骤是为确保批准相互之间交换而要求的。WhatsApp财务报告和已审计财务报表SMSMobileAPI。等待恢复,然后打电话/getwa.

打开所需的同步端点 {}
安全无虞SMSMobileAPI移动应用程序连接手机到网络仪表板和REST API,用于短信和呼叫操作
加密的移动到平台连接

官方移动应用程序

电话、仪表板和API之间的安全桥

短信和呼叫业务通过官员SMSMobileAPI应用程序安装在您的连接电话上 。 应用软件安全地将设备与您的账户对齐,同步了授权的事件,并将移动网络连接到仪表板和REST API.

1移动应用程序给手机和它的SIM配对 2加密链接认证和保护过境数据 3发牌机和 API控制工作流程和活动
  • 通过Google Play和App Store官方上市发布签名的版本
  • Google和苹果平台审查、签署和发行控制
  • 安全设备对接、HTTPS运输和认证的API访问
  • 仅为您启用的移动特性所需的权限
找官来SMSMobileAPI应用程序在Google Play 下载苹果App Store上的官方SMSMobileAPI应用
能力取决于Android或iOS允许的权限和背景访问.

此 API 的 WEBHOOK V2

仅订阅您的工作流所需的移动事件。

5 种事件类型

一个目标可以接收全部事件,或者您可以将生产系统、分析和运维告警分开。每个事件都有精确的名称,使您的应用能够可预测地处理它们。

whatsapp.submitted

WhatsApp 已提交

已创建一个 WhatsApp 发送任务。

whatsapp.sent

WhatsApp 已发送

已连接的 WhatsApp 环境确认消息已发送。

whatsapp.failed

WhatsApp 失败

WhatsApp 的发送操作失败。

whatsapp.received

WhatsApp 已接收

在账户请求同步后检索到了一条 WhatsApp 消息。

whatsapp.voice.transcribed

语音留言已转写

一条符合条件的检索到的 WhatsApp 语音留言已被转换为可用文本。

验证

在服务器上保存证书

直接集成时使用 apikey. OAuth2 客户端证书可用于服务器侧应用程序;请求一个符号并将其作为授权发送: Bearer Access TOKEN.

历史管理

安全清除历史: 预览、 删除、 跟踪进度

这些端点清除您所选服务器历史 API 键,而不是电话或外部服务中的信息。 它们不能提供账号的去除。 新的活性可以在删除后出现.

读取 request_id 和重试指南
保护已连接的外部集成

默认情况下,链接或处理记录仍然可见. 只使用 include_linked=1 或正在处理的软件。

怎样 request_id 工作内容

  1. 预览计数方式 action=preview。无 request_id 需要删除任何记录。
  2. 生成一个独特的 request_id 用于删除新内容,例如a UUID。发送前保存它 action=delete. . . . . . . . . . . .
  3. 重复、超时或 HTTP 202,再利用相同 API 键,历史终点, request_id 财务报告和已审计财务报表 include_linked 值。 错误发生后, 绝不自动生成新的 ID 。
  4. 何时 completed=true,操作结束。 重用其ID返回的相同结果,而不是删除新到的记录. 仅为有意进行新清理而使用新ID.

request_id 识别您的删除操作, 而不是个人 SMS允许的格式:16-128 ASCII 字母、数字、连字符或下划线。 A. 国家 UUID 用 Crypto.randomUUID () 生成是合适的。

删除按批次执行。如果返回 HTTP 202 且 continue_required=true,请在 3 秒后再次请求 action=delete。没有后台 cron 任务。action=status 只读取进度,不会继续删除,即使返回 HTTP 200 也是如此。

删除和查询状态的示例

替换样本 request_id 开始前,有你独特的价值。 以下删除请求更改真实账户历史; 它们不是预览 。

POST · 妇女 API 键
curl -X POST "https://api.smsmobileapi.com/delete-history-whatsapp-sent/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"
POST · 妇女 OAuth2
curl -X POST "https://api.smsmobileapi.com/delete-history-whatsapp-sent/" \
  -H "Authorization: Bearer YOUR_OAUTH_ACCESS_TOKEN" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"
GET 现状
curl -G "https://api.smsmobileapi.com/delete-history-whatsapp-sent/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=status" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"

GET 也接受 action=preview 或 或 双 action=delete. . . . . . . . . . . . POST 建议: URL参数可以被泄露到浏览器历史和服务器日志中. 永远不要将删除的 URL 放在公共链接, 图像或预选中 。

用于 POST,以窗体或一个格式发送所有参数 JSON 对象,从查询字符串中选择。 未知参数被拒绝;日期或移动过滤器不支持.

历史记录接口的身份验证

使用 apikey 或 一种 Authorization: 调取 Bearer 由 SMSMobileAPI OAuth2。不要发送刷新符号或 API 键为 a Bearer 符号。 过期的代币被拒绝.

瞄准镜设定完毕后 history:read 允许预览/状态和 history:delete 也允许删除。 对象征和 OAuth 客户端申请。 遗物无范围可查保留其现有的账户访问权.

OAuth2 选择唯一的主机 API 键。 如果存在几个主密钥,则还提供 apikey 以选择账户所属的账户。 次要钥匙从来不允许访问主要钥匙历史。

继续操作之前请先检查响应

count_delete 是该操作所删除的累积数。 selected_at_start 是初始选择; protected_at_start 记录不计在内。 使用 preview.linked_or_processing 以计算链接记录,即使 include_linked=1. . . . . . . . . . . .

JSON · 妇女 HTTP 202 (韩语).
{
    "result": {
        "error": 0,
        "history": "whatsapp-sent",
        "action": "delete",
        "request_id": "6d54ac58-41f1-4fbc-9a39-6e6c86089451",
        "status": "processing",
        "completed": false,
        "count_delete": 100,
        "total_before": 250,
        "selected_at_start": 200,
        "protected_at_start": 50,
        "include_linked": 0,
        "continue_required": true,
        "message": "Repeat GET or POST with the same request_id and include_linked to continue. Status requests do not run deletion."
    }
}
  • 200 与 . completed=true: 完成( 完成) 。 仅200个预览或状态回复并不能证明完成 。
  • 400,000 个 INVALID_REQUEST_ID:检查格式。 404 (中文(简体) ). REQUEST_NOT_FOUND: 没有为此ID操作, API 键和历史。
  • 401: 证书无效或过期. 403: 不足 OAuth 范围或未经授权的账户。
  • 409 (中文(简体) ). HISTORY_BUSY: 正在运行另一个清理; 从原客户端继续. 409 (中文(简体) ). INCLUDE_LINKED_CONFLICT: 恢复原样 include_linked 值。
  • 409 (中文(简体) ). OAUTH_ACCOUNT_AMBIGUOUS: 提供 API 属于此账户的密钥。
  • 503或网络中断:一些批次可能已经完成. 检查配置, 然后用原版重试 request_id中,不自动创建替换操作。
后 获得

发送WhatsApp 消息

#
终 编https://api.smsmobileapi.com/sendsms

通过连接环境发送WhatsApp文本或支持的媒体.

什么时候用

用于单个接收者或仪表板联络小组.

参数

姓名类型所需经费描述
apikey 细绳 必需的 您的 API 密钥; 使用 Bearer 符号时省略 。
recipients 电话 必需的 国号加号,不带+或00.
message 细绳 必需的 文本正文; 支持多行行 。
waonly 是的 必需的 一定是同意的,请求只提供WhatsApp。
url_media HTTPS URL 软件 可选 公共PDF,文档,存档或JPG/PNG URL.
url_media_shorted 是的 可选 使用带有 PDF 预览模式的缩短下载 URL 。
pdf_with_image 是的 可选 添加 PDF 的图像预览 。
encrypt_message 是的 可选 需要接受方解密.
contactGroup 图形化 可选 发送到仪表盘组中的每一个联系人。

请求示例

库尔
curl -X POST "https://api.smsmobileapi.com/sendsms?waonly=yes" \
  -d "apikey=YOUR_API_KEY" \
  -d "recipients=191728660" \
  --data-urlencode "message=Your order is ready."

示例回复

JSON
{
  "result": {
    "error": 0,
    "sent": "1",
    "id": "MESSAGE_GUID",
    "send_with_whatsapp": "1"
  }
}

想听这个请求吗?连接页面上方的 API 键以解锁交互式测试器 。

连接密钥 QQ
很高兴知道
  • 所支持的媒体URL必须是公共的HTTPS资源.
  • WhatsApp格式化: *bold *, italic , ~stription ~ 和 三后反相单相空间.
后 获得

重发送未发送的WhatsApp 信件

#
终 编https://api.smsmobileapi.com/resendwa/

重试当前有错误状态的WhatsApp消息 。

什么时候用

诊断失败的WhatsApp日志条目后使用它.

参数

姓名类型所需经费描述
apikey 细绳 必需的 您的 API 密钥。
guid 细绳 必需的 失败消息的 GUID 。

请求示例

库尔
curl "https://api.smsmobileapi.com/resendwa/?apikey=YOUR_API_KEY&guid=MESSAGE_GUID"

想听这个请求吗?连接页面上方的 API 键以解锁交互式测试器 。

连接密钥 QQ
很高兴知道
  • 只有失败的消息才有资格被再发送 。
得到

激活输入检索

#
终 编https://api.smsmobileapi.com/getwa/active/

激活、关闭或切换WhatsApp信件检索。

什么时候用

起动集先. 然后,在检索到收到的消息之前,必须请求通过/getwa/同步/同步进行同步.

参数

姓名类型所需经费描述
apikey 细绳 必需的 您的 API 密钥。
statut 0 | 1 | x 可选 1 激活, 0 失效, x 或忽略切换当前状态 。

请求示例

库尔
curl "https://api.smsmobileapi.com/getwa/active/?apikey=YOUR_API_KEY&statut=1"

示例回复

JSON
{
  "success": true,
  "read_message_active": 1,
  "status_note": "Activated"
}

想听这个请求吗?连接页面上方的 API 键以解锁交互式测试器 。

连接密钥 QQ
很高兴知道
  • 默认情况下, 无法进行输入检索 。
  • 单是激活不能检索到消息:在对新收到的活动使用/getwa之前,同步请求仍然具有强制性.
得到

需要: 请求WhatsApp同步

#
终 编https://api.smsmobileapi.com/getwa/synchronisation/

Mandatory security step before retrieving received WhatsApp messages. It opens a time-limited synchronization window.

什么时候用

需要时,请在/getwa前拨打这个终点SMSMobileAPI检查WhatsApp用于新收到消息。 等康复,然后打电话/getwa。

参数

姓名类型所需经费描述
apikey 细绳 必需的 您的 API 密钥。

请求示例

库尔
curl "https://api.smsmobileapi.com/getwa/synchronisation/?apikey=YOUR_API_KEY"

示例回复

JSON
{
  "error": "0",
  "messages": "synchronized",
  "expire_at": "2026-03-11 12:27:00",
  "expire_at_unix": "1773232020"
}

想听这个请求吗?连接页面上方的 API 键以解锁交互式测试器 。

连接密钥 QQ
很高兴知道
  • 同步仅用于接收信件 。 发送前不要叫它。
  • 回复返回已过期 at并过期 at unix 。 当需要收集新收到的信件时,请求另一个同步窗口 。
  • 同步请求是保护WhatsApp和SMSMobileAPI之间的交换的强制性要求.
得到

获取 WhatsApp 信件

#
终 编https://api.smsmobileapi.com/getwa

Returns received WhatsApp messages that were recovered during a requested synchronization window.

什么时候用

强制前提:激活入行检索,调用https://api.smsmobileapi.com/getwa/同步/先等恢复,再调用这个终点. /getwa本身不会开始同步.

参数

姓名类型所需经费描述
apikey 细绳 必需的 您的 API 密钥。
before 取消九分时戳 可选 回到记录之前的时间戳。
date 年-月-月-月 可选 一次约会的回程记录
message_type 文本 QQ 音频 可选 过滤文本或音频消息转换为文本;同时省略两者.

请求示例

库尔
curl "https://api.smsmobileapi.com/getwa/?apikey=YOUR_API_KEY&message_type=text"

示例回复

JSON
{
  "date": "2026-03-11",
  "hour": "12:27:00",
  "timestamp": "1773232020",
  "number": "19176728660",
  "contact": "SMSMobileAPI",
  "message": "When will I receive my order?",
  "guid": "652fcfc0-12a8-46f5-b5ba-9391135b8b4c"
}

想听这个请求吗?连接页面上方的 API 键以解锁交互式测试器 。

连接密钥 QQ
得到

检查一下WhatsApp的号码

#
终 编https://api.smsmobileapi.com/whatsapp/checknumber/

检查WhatsApp上是否有电话号码可用 。

什么时候用

在发送前使用以降低可避免的失败.

参数

姓名类型所需经费描述
apikey 细绳 必需的 您的 API 密钥。
recipients 电话 必需的 国号加号,不带+或00.

请求示例

库尔
curl "https://api.smsmobileapi.com/whatsapp/checknumber/?apikey=YOUR_API_KEY&recipients=19176728660"

示例回复

JSON
{
  "contact_found_on_whatsapp": "yes",
  "recipients": "19176728660"
}

想听这个请求吗?连接页面上方的 API 键以解锁交互式测试器 。

连接密钥 QQ
邮政

创建 OAuth2 访问符

#
终 编https://api.smsmobileapi.com/oauth2/token

交换客户证书 以获得一个熊熊的标志。

什么时候用

用于服务器对服务器集成,其中偏好使用短寿命的证书.

参数

姓名类型所需经费描述
grant_type 细绳 必需的 必须是客户端 证书 。
client_id 细绳 必需的 仪表板上的客户身份
client_secret 细绳 必需的 仪表板上的客户秘密

请求示例

库尔
curl -X POST "https://api.smsmobileapi.com/oauth2/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET"

想听这个请求吗?连接页面上方的 API 键以解锁交互式测试器 。

连接密钥 QQ
很高兴知道
  • 客户端在服务器上保密 。 永远不要将其包含在移动或浏览器代码中.
后 获得

清空已发送的 WhatsApp 消息记录

#
终 编https://api.smsmobileapi.com/delete-history-whatsapp-sent/

清除已发送的服务器记录 WhatsApp 留言。 它不会删除信件从 WhatsApp 谈话

什么时候用

首先使用预览,检查计数,然后明确请求删除. 清除了全部选取的历史 API 键,没有日期、电话或信件过滤器。

参数

姓名类型所需经费描述
apikey 细绳 可选 需要时无需 OAuth2与 OAuth2,可选择选择 API 属于同一账户的密钥。
action 预览 QQ 删除 QQ 状态 可选 preview 只统计而不删除;delete 启动或继续删除;status 只查看进度。API 默认使用 delete,此测试工具默认使用 preview。
include_linked 0 | 1 可选 默认 0: 保留链接或处理记录. 设定1以包含,有破坏整合的风险. 继续删除时保持此值不变 。
request_id 细绳 可选 delete 和 status 必须提供,preview 可不提供。使用 16–128 个 ASCII 字母、数字、连字符 (-) 或下划线 (_)。每次新的删除操作生成一个唯一 ID,并在所有重试中保留同一个 ID。它不是消息 ID,也不是 API 密钥。

请求示例

库尔
curl -X POST "https://api.smsmobileapi.com/delete-history-whatsapp-sent/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=preview" -d "include_linked=0"
删除和查询状态的示例

替换样本 request_id 开始前,有你独特的价值。 以下删除请求更改真实账户历史; 它们不是预览 。

POST · 妇女 API 键
curl -X POST "https://api.smsmobileapi.com/delete-history-whatsapp-sent/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"
POST · 妇女 OAuth2
curl -X POST "https://api.smsmobileapi.com/delete-history-whatsapp-sent/" \
  -H "Authorization: Bearer YOUR_OAUTH_ACCESS_TOKEN" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"
GET 现状
curl -G "https://api.smsmobileapi.com/delete-history-whatsapp-sent/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=status" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"

示例回复

JSON
{
    "result": {
        "error": 0,
        "history": "whatsapp-sent",
        "action": "preview",
        "total": 120,
        "simple": 100,
        "linked_or_processing": 20,
        "selected": 100,
        "include_linked": 0,
        "operation_in_progress": false,
        "active_include_linked": null
    }
}

想听这个请求吗?连接页面上方的 API 键以解锁交互式测试器 。

连接密钥 QQ
很高兴知道
  • 以上示例为预览,而非删除. 计数是说明;删除开始时确定选择。
  • include_linked=1 可能破坏 GHL, , , , , , , , Zapier,自动化,不订阅链接或发送跟踪. 它从不绕过账户所有权或存储完整性检查.
后 获得

清空已接收的 WhatsApp 消息记录

#
终 编https://api.smsmobileapi.com/delete-history-whatsapp-received/

清除已接收的服务器记录 WhatsApp 留言。 无法断开 WhatsApp 或删除对话框。

什么时候用

首先使用预览,检查计数,然后明确请求删除. 清除了全部选取的历史 API 键,没有日期、电话或信件过滤器。

参数

姓名类型所需经费描述
apikey 细绳 可选 需要时无需 OAuth2与 OAuth2,可选择选择 API 属于同一账户的密钥。
action 预览 QQ 删除 QQ 状态 可选 preview 只统计而不删除;delete 启动或继续删除;status 只查看进度。API 默认使用 delete,此测试工具默认使用 preview。
include_linked 0 | 1 可选 默认 0: 保留链接或处理记录. 设定1以包含,有破坏整合的风险. 继续删除时保持此值不变 。
request_id 细绳 可选 delete 和 status 必须提供,preview 可不提供。使用 16–128 个 ASCII 字母、数字、连字符 (-) 或下划线 (_)。每次新的删除操作生成一个唯一 ID,并在所有重试中保留同一个 ID。它不是消息 ID,也不是 API 密钥。

请求示例

库尔
curl -X POST "https://api.smsmobileapi.com/delete-history-whatsapp-received/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=preview" -d "include_linked=0"
删除和查询状态的示例

替换样本 request_id 开始前,有你独特的价值。 以下删除请求更改真实账户历史; 它们不是预览 。

POST · 妇女 API 键
curl -X POST "https://api.smsmobileapi.com/delete-history-whatsapp-received/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"
POST · 妇女 OAuth2
curl -X POST "https://api.smsmobileapi.com/delete-history-whatsapp-received/" \
  -H "Authorization: Bearer YOUR_OAUTH_ACCESS_TOKEN" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"
GET 现状
curl -G "https://api.smsmobileapi.com/delete-history-whatsapp-received/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=status" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"

示例回复

JSON
{
    "result": {
        "error": 0,
        "history": "whatsapp-received",
        "action": "preview",
        "total": 120,
        "simple": 100,
        "linked_or_processing": 20,
        "selected": 100,
        "include_linked": 0,
        "operation_in_progress": false,
        "active_include_linked": null
    }
}

想听这个请求吗?连接页面上方的 API 键以解锁交互式测试器 。

连接密钥 QQ
很高兴知道
  • 以上示例为预览,而非删除. 计数是说明;删除开始时确定选择。
  • include_linked=1 可能破坏 GHL, , , , , , , , Zapier,自动化,不订阅链接或发送跟踪. 它从不绕过账户所有权或存储完整性检查.

故障排除

错误和安全的重试

在重试前读取 HTTP 状态和 JSON 错误字段 。 不先更正请求, 不重试验证或认证失败 。

HTTP代码怎么办
400missing_parameter需要的参数为空或缺失 。 请检查endpoint的参数表.
403invalid_apikeyAPI 密钥未知, 过期或未授权用于请求的特性 。
429too_many_requests请求来得太快了 等等,然后用指数回放来重试.
500server_error服务无法完成请求 。 如果持续,则保持响应和联系支持。
重试规则重试仅进行瞬态429和5xx响应. 1秒后开始,然后回到2,4和8秒.

需要帮助吗?

带上请求的背景 而不是你的秘密

共享端点,时间戳,HTTP状态和消毒响应. 永远不要包括API密钥,指使或私人消息内容.

联系API支持