SDK 功能简介
目前腾讯云短信为客户提供国内短信和国际/港澳台短信服务,腾讯云短信 SDK 支持以下操作:
说明
群发短信
一次群发请求最多支持200个号码,如对号码数量有特殊需求请联系腾讯云短信技术支持(QQ:3012203387)。
拉取短信回执
该功能默认关闭。您可以根据实际需求联系腾讯云短信技术支持(QQ:3012203387)开通,实现批量拉取短信回执。
SDK 使用指南
相关资料
前提条件
在使用 SDK 前,您需要准备以下信息:
申请签名并确认审核通过
一个完整的短信由短信签名和短信正文内容两部分组成,短信签名需申请和审核,签名可在 短信控制台 的相应服务模块【内容配置】中进行申请,详细申请操作请参见 创建签名。发送国际/港澳台短信时,允许不携带签名。
配置 SDK
pip 配置:
qcloudsms_py 采用 pip 进行安装,要使用 qcloudsms 功能, 只需要执行:
pip install qcloudsms_py
手动配置:
1.手动下载或 clone 最新版本 qcloudsms_py 代码。
2.在 qcloudsms_py 目录运行
python setup.py install
或直接把 qcloudsms_py 所在目录加入sys.path
。说明
Python 2/Python 3都支持。
示例代码
说明
所有示例代码仅作参考,无法直接编译和运行,需根据实际情况进行修改。
准备必要参数
# 短信应用 SDK AppIDappid = 1400009099 # SDK AppID 以1400开头# 短信应用 SDK AppKeyappkey = "9ff91d87c2cd7cd0ea762f141975d1df37481d48700d70ac37470aefc60f9bad"# 需要发送短信的手机号码phone_numbers = ["21212313123", "12345678902", "12345678903"]# 短信模板ID,需要在短信控制台中申请template_id = 7839 # NOTE: 这里的模板 ID`7839` 只是示例,真实的模板 ID 需要在短信控制台中申请# 签名sms_sign = "腾讯云" # NOTE: 签名参数使用的是`签名内容`,而不是`签名ID`。这里的签名"腾讯云"只是示例,真实的签名需要在短信控制台中申请
指定模板 ID 单发短信
from qcloudsms_py import SmsSingleSenderfrom qcloudsms_py.httpclient import HTTPErrorssender = SmsSingleSender(appid, appkey)params = ["5678"] # 当模板没有参数时,`params = []`try:result = ssender.send_with_param(86, phone_numbers[0],template_id, params, sign=sms_sign, extend="", ext="")except HTTPError as e:print(e)except Exception as e:print(e)print(result)
指定模板 ID 群发短信
from qcloudsms_py import SmsMultiSenderfrom qcloudsms_py.httpclient import HTTPErrormsender = SmsMultiSender(appid, appkey)params = ["5678"]try:result = msender.send_with_param(86, phone_numbers,template_id, params, sign=sms_sign, extend="", ext="")except HTTPError as e:print(e)except Exception as e:print(e)print(result)
拉取短信回执以及回复
from qcloudsms_py import SmsStatusPullerfrom qcloudsms_py.httpclient import HTTPErrormax_num = 10 # 单次拉取最大量spuller = SmsStatusPuller(appid, appkey)try:# 拉取短信回执callback_result = spuller.pull_callback(max_num)# 拉取回复(国际/港澳台短信不支持回复功能)reply_result = spuller.pull_reply(max_num)except HTTPError as e:print(e)except Exception as e:print(e)print(callback_result)print(reply_result)
拉取单个手机短信状态
from qcloudsms_py import SmsMobileStatusPullerfrom qcloudsms_py.httpclient import HTTPErrorbegin_time = 1511125600 # 开始时间(UNIX timestamp)end_time = 1511841600 # 结束时间(UNIX timestamp)max_num = 10 # 单次拉取最大量mspuller = SmsMobileStatusPuller(appid, appkey)try:# 拉取短信回执callback_result = mspuller.pull_callback("86", phone_numbers[0],begin_time, end_time, max_num)# 拉取回复,国际/港澳台短信不支持回复功能reply_result = mspuller.pull_reply("86", phone_numbers[0],begin_time, end_time, max_num)except HTTPError as e:print(e)except Exception as e:print(e)print(callback_result)print(reply_result)
发送国际/港澳台短信
发送国际/港澳台短信与发送国内短信类似,只需替换相应的国家码或地区码。详细示例请参考:
指定模板单发短信
指定模板群发短信
拉取短信回执
使用代理
有的环境需要使用代理才能上网,可以指定 HTTPSimpleClient 的 proxy 参数来实现, 示例如下:
from qcloudsms_py import SmsSingleSenderfrom qcloudsms_py.httpclient import HTTPSimpleClient, HTTPErrorhttpclient = HTTPSimpleClient(proxy="www.proxysever.com:8080")ssender = SmsSingleSender(appid, appkey, httpclient=httpclient)template_id = 7839params = ["5678"]try:result = ssender.send_with_param(86, phone_numbers[0],template_id, params, sign=sms_sign, extend="", ext="")except HTTPError as e:print(e)except Exception as e:print(e)print(result)
统一创建对象
短信类的对象可以通过 qcloudsms_py.QcloudSms 统一创建,这种方式可以避免创建对象时多次传入参数 appid 和 appkey, 示例如下:
from qcloudsms_py import QcloudSms# 创建 QcloudSms 对象qcloudsms = QcloudSms(appid, appkey)# 创建单发短信 SmsSingleSender 对象ssender = qcloudsms.SmsSingleSender()