免费服务热线:13871192070
一、概述
短信平台接口文档旨在为开发者提供一个便捷、高效、稳定的短信发送服务。本文档主要介绍了短信平台接口的使用方法、请求参数、返回值及错误码等,帮助开发者快速集成短信服务到自己的系统中。
二、接口地址
短信平台接口地址:https://example.com/sms/send
三、请求方法
POST
四、请求参数
| 参数名 | 类型 | 必选 | 说明 | | ------ | ------ | ---- | -------- | | phone | string | 是 | 接收短信的手机号码 | | content | string | 是 | 短信内容 | | sign | string | 否 | 短信签名,默认为空 | | templateId | string | 否 | 短信模板ID,默认为空 |
五、返回值
成功返回示例:
```json { code: 200, message: 短信发送成功, data: { phone: 13812345678, content: 这是一条测试短信, sendTime: 2022-01-01 12:00:00 } } ```
失败返回示例:
```json { code: 400, message: 短信发送失败, data: { phone: 13812345678, content: 这是一条测试短信, errorMessage: 手机号码格式错误 } } ```
六、错误码
| 错误码 | 说明 | | ------ | -------- | | 200 | 短信发送成功 | | 400 | 短信发送失败 | | 401 | 未授权 | | 402 | 手机号码格式错误 | | 403 | 短信内容格式错误 | | 404 | 短信签名格式错误 | | 405 | 短信模板ID格式错误 | | 406 | 短信模板不存在 | | 407 | 短信平台内部错误 |
七、使用示例
```python import requests
url = https://example.com/sms/send phone = 13812345678 content = 这是一条测试短信
data = { phone: phone, content: content }
response = requests.post(url, json=data)
if response.status_code == 200: print(短信发送成功, response.json()) else: print(短信发送失败, response.json()) ```
八、注意事项
1. 请确保提供的手机号码格式正确。 2. 短信内容需符合运营商规定,避免敏感词汇。 3. 短信签名及模板ID需在短信平台后台申请,并确保格式正确。 4. 短信平台接口可能会受到运营商限制,如发送速度限制等,请合理使用。
通过以上介绍,希望能帮助开发者快速集成短信服务,如有任何问题,请随时联系我们。