开发文档 - SMSMobileAPI
 

发送短信

此端点允许您从手机发送短信。

端点: 

得到 邮政 https://api.smsmobileapi.com/sendsms/

参数:

范围描述
apikey
必需的
您的唯一 API 密钥。
recipients
必需的
收件人的电话号码。
message
必需的
要发送的消息(无 160 个字符的限制)。
port 定义用于发送短信的SIM卡端口: 1, 2或者留空。
如果留空,短信将自动通过可用的 SIM 卡端口发送。

此参数从 Android 版本开始可用 4.1.15.0 当应用程序处于以下状态时,该功能有效: 前景 (第一方案)。
shorturl1 = 将 URL 转换为短链接
0 或空值 = 不进行转换
sIdentifiant选择要发送短信的已连接手机。留空则默认使用第一个可用的设备。需要应用版本 3.0.35.3 或更高版本。
sendwa1 = 通过 WhatsApp 发送。
sendsms1 = 通过短信发送(如果为空则为默认值)。设置为 0 可阻止短信发送。
encrypt_message是的 接收者需要密钥才能解密。 了解更多
schedule_timestampUNIX 时间戳(GMT 0),即短信发送的时间戳。

例子:

GET https://api.smsmobileapi.com/sendsms?apikey=YOUR_API_KEY&recipients=+1234567890&message=HelloWorld
注意:如果因运营商原因导致配送错误,默认功能最多会重试 3 次。
 

重新发送未发送的短信

此 API 端点用于重新发送未发送的短信(仅当消息状态为错误时)。

端点:

得到 邮政 https://api.smsmobileapi.com/resend/

范围: 

范围描述
guid
必需的
要重新发送的消息的 GUID。

例子: 

获取 https://api.smsmobileapi.com/resend/?apikey=YOUR_API_KEY&guid=GUID_OF_THE_MESSAGE
 

从 API 发送的短信日志

此 API 端点用于检索通过 API 发送的 SMS 消息的日志。

端点: 

得到 https://api.smsmobileapi.com/log/sent/sms/

范围:

范围描述
apikey
必需的
您的 API 密钥。
guid_message按邮件的唯一标识符筛选。
before检索在此时间戳或 GUID 之前发送的消息。
error_api1 = 列出包含 API 请求错误的短信。
error_mobile1 = 列出存在移动处理错误的短信。
keyword按收件人号码或消息内容筛选。

例子:

获取 https://api.smsmobileapi.com/log/sent/sms?apikey=YOUR_API_KEY
 

短信已接收

此 API 端点用于检索智能手机上收到的短信。 

端点:

得到 https://api.smsmobileapi.com/getsms/

范围: 

范围描述
apikey
必需的
您拥有或将收到的 API 密钥。
sIdentifiantPhone隔离与已接收短信关联的手机。
after_timestamp_unix列出 UNIX 时间戳之后收到的短信。
onlyunread“yes” = 仅列出未标记为已读的短信(API 状态)。

例子:

获取 https://api.smsmobileapi.com/getsms/?apikey=YOUR_API_KEY
 

将收到的短信标记为已读

此 API 端点用于将收到的短信标记为已读。 仅限 API 状态.
这不会改变智能手机上的已读状态。  

端点:

得到 https://api.smsmobileapi.com/getsms/set-read/

范围: 

范围描述
apikey
必需的
您拥有或将收到的 API 密钥。
guid_message
必需的
要标记为已读的消息的 GUID。

例子:

获取 https://api.smsmobileapi.com/getsms/set-read/?apikey=YOUR_APIKEY&guid_message=GUID_MESSAGE
 

删除短信

此 API 端点用于从 SMS Mobile API 的服务器日志中删除短信。

端点: 

得到 https://api.smsmobileapi.com/deletesms/

范围:

范围描述
apikey
必需的
您拥有的 API 密钥。
guid_message要删除的消息的唯一 ID。
date_start如果单独使用,则会删除指定日期的所有消息。
date_start and date_end合并删除指定时间段内的消息。

例子:

获取 https://api.smsmobileapi.com/deletesms/?apikey=YOUR_API_KEY

注意:已删除的短信仅指存储在服务器日志中的短信。设备上的短信不会被删除。

网关 – 列出已连接的移动设备。

列出连接到您的设备的手机 短信网关.

端点:

得到 邮政 https://api.smsmobileapi.com/gateway/mobile/list/

参数:

范围描述
apikey
必需的
您的 API 密钥。
sid按精确 SID 筛选(sIdentifiant_pour_check)。
search按字段(sid、日期、电池、版本、标签……)搜索。

例子:

GET https://api.smsmobileapi.com/gateway/mobile/list/?apikey=YOUR_API_KEY
注意:从移动应用程序版本 3.0.33.3 及更高版本开始,即可查看已接收短信统计信息。

网关 – 更新移动标签

更新已连接移动设备的标签(nom_reference)。

端点:

得到 邮政 https://api.smsmobileapi.com/gateway/mobile/update/

参数:

范围描述
apikey
必需的
您的 API 密钥。
sid
必需的
设备 SID(sIdentifiant_pour_check)。
label
必需的
新标签(可以为空)。

例子:

GET https://api.smsmobileapi.com/gateway/mobile/update/?apikey=YOUR_API_KEY&sid=SID&label=OfficePhone

重要的: 标签为必填项,但可以为空。 (标签=)。

网关 – 删除已连接的移动设备

从网关中移除已连接的移动设备(删除此 SID 的所有历史记录行)。

端点:

得到 邮政 https://api.smsmobileapi.com/gateway/mobile/delete/

参数:

范围描述
apikey
必需的
您的 API 密钥。
sid
必需的
设备 SID(sIdentifiant_pour_check)。

例子:

GET https://api.smsmobileapi.com/gateway/mobile/delete/?apikey=YOUR_API_KEY&sid=SID
 

Webhook – 短信已接收

此 webhook 系统每次收到短信时都会向配置的 URL 发送 POST 请求。系统通过将短信详细信息发送到指定的 webhook URL 来确保实时更新。

如何在仪表板中配置 Webhook

按照以下步骤在仪表板中设置您的 webhook URL:

  1. 登录您的账户 SMS 移动 API 仪表板.
  2. 导航至 Webhook 设置 部分。
  3. 输入你的 webhook URL(例如, https://example.com/webhook-endpoint).
  4. 点击 保存 Webhook 按钮。 
  5. 保存后,系统将开始向配置的 URL 发送短信详细信息。

Webhook 负载

收到短信时,系统会将以下 JSON 负载发送到您的 webhook URL:

{ "date": "2025-01-20", "hour": "10:15:00", "time_received": "2025-01-20 10:14:50", "message": "你好,这是个测试。", "number": "+123456789", "guid": "abcde12345" }

有效载荷字段:

  • 日期: 添加短信的日期(YYYY-MM-DD)。
  • 小时: 添加短信的小时(HH:mm:ss)。
  • 接收时间: 短信收到时间。
  • 信息: 短信内容。 
  • 数字: 发件人的电话号码。
  • 指南: 短信的唯一标识符。

Webhook 端点示例

您的服务器应已准备好处理传入的 POST 请求。以下是用于处理 webhook 负载的示例 PHP 脚本:

测试 Webhook

要测试你的 webhook 配置,请使用以下工具:

故障排除

  • 确保 webhook URL 正确且可公开访问。
  • 验证您的服务器是否在成功请求时返回 HTTP 200 状态代码。
  • 检查您的服务器日志,查找处理有效负载时出现的任何错误。

增强型短信

即将推出

验证

 

SMSMobile API 支持两种身份验证方法:使用简单的 API 密钥或带有客户端 ID 和客户端密钥的 OAuth2 协议。

1. API 密钥认证

 此方法需要一个 API 密钥,该密钥可以作为参数包含在 GET 或 POST 请求中。

2. OAuth2 身份验证

OAuth2 提供了一种更安全的身份验证方法。
使用客户端 ID 和客户端密钥获取访问令牌,然后将其包含在内 授权 標軸。

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"

使用访问令牌:

curl -X POST https://api.smsmobileapi.com/sendsms \
-H "授权:持有者 YOUR_ACCESS_TOKEN" \
-H“内容类型:application/x-www-form-urlencoded” \
-d“收件人=+1234567890”\
-d“消息=你好”

您应该使用哪种方法?

- 使用 API 密钥认证 实现快速、直接的集成。

- 使用 OAuth2 身份验证 为了增强安全性和可扩展性。

发送短信

WSDL 网址

https://api.smsmobileapi.com/sendsms/wsdl/sendsms.wsdl

参数:

- recipients: 收件人的手机号码。
- message: 要发送的消息。
- apikey: 您拥有或将收到的 API 密钥。

例子

require_once "lib/nusoap.php";

$client = new nusoap_client("https://api.smsmobileapi.com/sendsms/wsdl/sendsms.wsdl", true);
$error = $client->getError();

$result = $client->call("sendSms", array("recipients" =>$_GET['recipients'],"message" =>$_GET['message'],"apikey" =>$_GET['apikey']));

print_r($result);

发送短信和 WhatsApp

基本 cURL 命令

curl -X POST https://api.smsmobileapi.com/sendsms/ \
-d "recipients=PHONE_NUMBER" \
-d "message=YOUR_MESSAGE" \
-d "apikey=YOUR_API_KEY"
-d "sendwa=1"
-d "sendsms=1"

发送短信和 WhatsApp

使用我们的官方 Python 模块: https://smsmobileapi.com/python/

import requests

url = "https://api.smsmobileapi.com/sendsms/"

payload = {"recipients":"PHONE_NUMBER","message":"YOUR_MESSAGE","apikey":"YOUR_API_KEY"}

response = requests.post(url, data=payload)
print(response.text)

SMS 移动 API - PHP SDK (Composer)

Composer 需要 smsmobileapi/sdk

GitHub: https://github.com/SmsMobileApi/smsmobileapi-php/tree/main

发送短信和 WhatsApp

const url = "https://api.smsmobileapi.com/sendsms/";
const data = {recipients:"PHONE_NUMBER", message:"YOUR_MESSAGE", apikey:"YOUR_API_KEY"};
fetch(url,{method:"POST",headers:{"Content-Type":"application/x-www-form-urlencoded"},body:new URLSearchParams(data)})
.then(r=>r.text()).then(console.log);

发送短信和 WhatsApp

const axios = require("axios");
axios.post("https://api.smsmobileapi.com/sendsms/", {recipients:"PHONE_NUMBER", message:"YOUR_MESSAGE", apikey:"YOUR_API_KEY"})
.then(r=>console.log(r.data));

发送短信和 WhatsApp

require "net/http"
require "uri"
uri = URI.parse("https://api.smsmobileapi.com/sendsms/")
req = Net::HTTP::Post.new(uri)
req.set_form_data({"recipients"=>"PHONE_NUMBER","message"=>"YOUR_MESSAGE","apikey"=>"YOUR_API_KEY"})
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true){|http| http.request(req)}
puts res.body
根据手机上安装的 Android 版本,当 SmsMobileApi 应用程序不在前台时,操作系统可能会阻碍自动发送和接收短信的正常功能。
此问题是由在应用程序未主动启动时尝试在后台运行的进程引起的。但是,由于 Android 的电池优化措施(不同版本的措施有所不同),此后台进程可能无法正确启动。Android 的电池优化旨在限制应用程序的后台活动以节省电池寿命,这可能会无意中影响需要后台进程才能正常运行的应用程序。

为了解决这个问题,用户可以手动配置他们的 Android 设置,以允许 SmsMobileApi 不受限制地使用资源。
这涉及调整特定应用的电池优化设置,本质上是指示 Android 允许 SmsMobileApi 在后台运行并根据需要使用资源。这样,即使应用程序不是前台的活动应用程序,它也应该能够自动发送和接收短信。此调整可确保必要的后台进程可以不间断运行,从而绕过可能阻止其正常执行的电池优化功能。


开发者常见问题解答

Accordion 示例说明要生成 API 密钥,请将我们的应用程序下载到您的手机上并免费创建一个帐户。API 密钥将自动生成并链接到您的手机。您还将收到一封包含所有必要信息的电子邮件。此过程可确保您能够以最少的设置快速轻松地开始使用我们的服务。
在您的移动应用程序中,导航至“设置”或“帮助”菜单,您的 API 密钥始终可见。这可确保您在需要集成或使用我们的服务时,可以轻松访问您的 API 密钥。
是的,我们不需要任何身份证明来创建 API 密钥。因此,我们的 API 与您的手机之间的通信是 100% 匿名的。这种方法允许用户在使用我们的服务时保持隐私。

立即开始使用 SMSmobileAPI!

体验随时随地管理短信服务的自由和灵活性。立即下载我们的移动应用程序,迈出无缝短信集成的第一步。

下载应用程序
💬 实时聊天
💬 提供实时聊天
有任何问题或需要帮助吗?
我们的团队随时为您提供帮助!

输入您的电子邮件地址
帮助我们跟进您的请求:
仪表板