短信服务 API 文档
本文档提供了短信服务的详细使用指南，帮助您快速集成和使用我们的服务。
快速开始
2. 安装 SDK
我们提供多种语言的 SDK，您可以选择适合您项目的 SDK 进行安装。
npm install @smslab/sdk
3. 发送您的第一条短信
以下是一个简单的示例，展示如何使用我们的 SDK 发送短信：
import { SMSLabClient } from '@smslab/sdk';
// 初始化客户端
const client = new SMSLabClient({
apiKey: 'YOUR_API_KEY',
apiSecret: 'YOUR_API_SECRET'
});
// 发送短信
async function sendVerificationCode() {
try {
const result = await client.sendMessage({
phoneNumber: '13812345678',
templateId: 'VERIFICATION_CODE_TEMPLATE',
params: {
code: '123456',
time: '5'
}
});
console.log('短信发送成功:', result.messageId);
} catch (error) {
console.error('短信发送失败:', error);
}
}
sendVerificationCode();
API 参考
完整 API 文档POST
/api/v1/messages/send请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| phoneNumber | String | 是 | 接收短信的手机号码 |
| templateId | String | 是 | 短信模板ID |
| params | Object | 是 | 模板参数，用于替换模板中的变量 |
GET
/api/v1/messages/status/{messageId}路径参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| messageId | String | 短信ID，发送短信时返回 |
SDK 使用
SDK 功能概览
我们的 SDK 提供了丰富的功能，使您可以轻松集成短信服务到您的应用中：
- 支持多种短信类型：验证码、通知、营销等
- 批量发送和定时发送功能
- 完整的错误处理和重试机制
代码示例
批量发送示例
import { SMSLabClient } from '@smslab/sdk';
// 初始化客户端
const client = new SMSLabClient({
apiKey: 'YOUR_API_KEY',
apiSecret: 'YOUR_API_SECRET'
});
// 批量发送短信
async function batchSendMessages() {
try {
const result = await client.batchSend({
templateId: 'NOTIFICATION_TEMPLATE',
recipients: [
{
phoneNumber: '13812345678',
params: { name: '张三', event: '年度促销' }
},
{
phoneNumber: '13987654321',
params: { name: '李四', event: '年度促销' }
}
]
});
console.log('批量发送成功:', result.successCount);
} catch (error) {
console.error('批量发送失败:', error);
}
}
batchSendMessages();
常见问题
短信发送失败怎么办？
短信发送失败可能有多种原因，如手机号格式错误、模板参数不匹配、账户余额不足等。您可以通过查看返回的错误码和错误信息来确定具体原因，并采取相应的措施进行解决。
如何提高短信送达率？
要提高短信送达率，您可以：确保手机号码格式正确、避免发送包含敏感词的内容、选择合适的发送时间、使用已审核通过的模板、避免频繁发送给同一用户等。
高级功能
批量发送
通过批量发送功能，您可以一次性向多个用户发送相同或不同内容的短信，提高发送效率。
定时发送
可以预设发送时间，系统会在指定时间自动发送短信，适合活动预告、生日祝福等场景。
Webhook 回调
通过配置 Webhook，您可以实时接收短信状态变更通知，便于与自有系统集成。
多通道路由
系统支持多通道智能路由，根据目标手机号、短信内容、发送时间等因素自动选择最优发送通道。