文档

发送您的第一条消息 一个下午

用于发送、跟踪和接收 SMS 的普通 REST API — 令牌身份验证、实时 Webhooks 和 SDK,无需学习任何新奇内容。

快速入门

三招,开始交付

每个集成都是相同的短弧——验证、发送,然后跟踪。

01 · 认证代币:sk_live_9f2a7c10内容类型:application/json ✓

在每个请求中,将您的访问密钥作为令牌标头发送,内容类型为 application/json。

02 · 发送POST /外部/短信{ msgid: "9f2a7c10", 错误代码: 0 }

发布发件人、收件人和内容。响应立即返回一个 msgid 和一个错误代码。

03 · 追踪获取/报告?状态=Delivrd200 好

当消息达到最终状态时,我们会向您的回调 URL 发送或获取状态报告。

发送

使用您已使用的语言提出一项请求

使用令牌标头发布您的发件人、收件人和内容。当我们接受它时,就会返回响应。

01curl -X POST https://secure.smslocal.com/api/service/enterprise-service/external/sms \02  -H "Token: $SMSLOCAL_TOKEN" \03  -H "Content-Type: application/json" \04  -d '{05    "from": "SMSLOCAL",06    "to": "14155550123",07    "content": "Your code is 481920."08  }'
201 · 已接受

消息标识符 “9f2a7c10-4b2e-…”

方向 “公吨”

错误码 0

保存 消息标识符 — 这是您从此处跟踪此消息的方式。

消息对象

从上到下阅读消息

发送、状态和入站事件都返回相同的形状 - 了解一次。

01消息ID

消息ID

msgid — 在创建消息时创建。这是您稍后用来检查其状态的句柄。

02发件人

发件人

发件人 — 电话号码或最多 11 个字符的字母数字 ID,以您的收件人看到的身份为准。

03接受者

接受者

to — 消息要发送到的号码,包括国家/地区代码。

04编码

编码

数据编码 — GSM7 每个部分适合 160 个字符;切换到 Unicode,就会下降到 70。再过去,它会连接成额外的计费部分。

05方向

方向

方向 — 每条消息都是 mt(您发送的)或 mo(您收到的),无论哪种方式,形状都相同。

06错误代码

错误代码

错误代码 — 在发送响应和每个状态报告上返回。 0表示接受;其他任何事情都会告诉你到底出了什么问题。

参考

一个端点,两个动词

POST 发送,GET 检查状态——无论哪种方式都是相同的 URL 和相同的 Token 标头。

邮政

发送

发送消息并立即返回 msgid 和错误代码。

退货 msgid + 错误代码
得到

追踪

查找您已发送的消息以检查其当前状态。

退货 消息+状态
网络钩子

状态报告,发生的那一刻

设置回调 URL,每次传送、失败和入站回复都会以 GET 或 POST 形式到达那里 — 无需轮询。

发表msgid 9f2a7c10 · 状态 Delivrd
入境已收到回复·方向
失败的msgstr 4c81e2 · 状态失败
您的端点200 好
开始使用

获取您的 API 密钥

只需几分钟即可开始与我们的 REST API 集成。

回答您的问题

开发人员文档 - 常见问题

在每个请求的 Token 标头中传递您的访问密钥 — Token: {accessKey} — 以及 Content-Type: application/json。

每次发送都会返回一个 msgid。将我们指向回调 URL,当消息到达其最终状态(包括 subdate、donedate 和结果状态代码)时,我们会向其 POST 或 GET 状态报告。

mt(移动终止)是您发送的消息; mo(移动发起)是您收到的回复。两者都使用相同的消息对象形状。

根据重试策略重试传递 - 不会默默地丢弃任何内容,但从不确认的端点将继续接收重试。

GSM7 编码为 160 个字符,Unicode 为 70 个字符。超过限制后,消息会连接成多个部分,每个部分单独计费。