1. 前提条件
在安装和使用Python SDK前，确保您已经：
- 安装Python 环境。云通讯 Python SMS SDK要求使用Python 3.6 或更高版本。
- 已经注册云通讯账号且已获取auth token，并已开通应用
2. Python SDK使用说明
2.1 SDK目录结构
- python-sms-sdk
- │ readme.md
- | requirements.txt
- ├─example
- │ SendMessage.py -- 发送短信示例
- │
- ├─ronglian_sms_sdk
- │ │ algorithm.py -- SDK依赖算法
- │ │ SmsSDK.py -- 短信SDK
- │ │ __init__.py
2.2 安装SDK
- $ pip install ronglian_sms_sdk
- Collecting ronglian_sms_sdk…
- √ Successfully installed ronglian-sdk-xx
- …
2.3 初始化SDK
- sdk = SmsSDK(accId, accToken, appId)
2.4 调用发送短信方法
- sdk.sendMessage(tid, mobile, datas)
3. 方法参数说明
3.1 初始化方法
- __init__(self, accId, accToken, appId)
| 参数 | 类型 | 说明 |
| accId | String | 开发者主账号,登陆云通讯网站后,可在控制台首页看到开发者主账号ACCOUNT SID |
| accToken | String | 主账号令牌 TOKEN,登陆云通讯网站后,可在控制台首页看到主账号令牌AUTH TOKEN |
| appId | String | 请使用管理控制台中已创建应用的APPID |
3.2 调用发送短信方法
- sendMessage(self, tid: str, mobile: str, datas: tuple) -> str
| 参数 | 类型 | 说明 |
| tid | String | 短信模板 ID |
| mobile | String | 发送手机号，多个以英文逗号分隔，最多 200 个号码 |
| datas | tuple | 替换短信模板占位符的内容变量 |
3.3 响应参数
- {"statusCode":"000000","templateSMS":{"dateCreated":"20130201155306","smsMessageSid":"ff8080813c373cab013c94b0f0512345"}}
| 参数 | 类型 | 说明 |
| statusCode | String | 状态码，000000 为发送成功 |
| dateCreated | String | 短信的创建时间，格式：yyyyMMddHHmmss |
| smsMessageSid | tuple | 短信唯一标识符 |
4. Python SDK GitHub地址
5. 调用示例
- from ronglian_sms_sdk import SmsSDK
- accId = '容联云通讯分配的主账号ID'
- accToken = '容联云通讯分配的主账号TOKEN'
- appId = '容联云通讯分配的应用ID'
- def send_message():
- sdk = SmsSDK(accId, accToken, appId)
- tid = '容联云通讯创建的模板ID'
- mobile = '手机号1,手机号2'
- datas = ('变量1', '变量2')
- resp = sdk.sendMessage(tid, mobile, datas)
- print(resp)
6. SDK 状态码
| 状态码 | 描述 |
| 000000 | 请求成功 |
| 172001 | 网络错误 |
SDK 会透传容联云通讯服务端错误码，具体请参见《
短信错误码》