1.獲取阿里雲訪問金鑰
為了使用簡訊傳送API-Python SDK,您必須申請阿里雲的訪問金鑰。
阿里雲訪問祕鑰是阿里云為使用者使用 API(非控制檯)來訪問其雲資源設計的“安全口令”。您可以用它來簽名 API 請求內容以通過服務端的安全驗證。
該訪問祕鑰成對(AccessKeyId 與 AccessKeySecret)生成和使用。每個阿里雲使用者可以建立多對訪問祕鑰,且可隨時啟用(Active)、禁用(Inactive)或者刪除已經生成的訪問祕鑰對。
您可以通過阿里雲控制檯的 祕鑰管理頁面 建立、管理所有的訪問祕鑰對,且保證它處於“啟用”狀態。由於訪問祕鑰是阿里雲對 API 請求進行安全驗證的關鍵因子,請妥善保管你的訪問祕鑰。如果某些祕鑰對出現洩漏風險,建議及時刪除該祕鑰對並生成新的替代祕鑰對。
2.在控制檯完成模板與簽名的申請,獲得呼叫介面必備的引數
簡訊簽名
根據使用者屬性來建立符合自身屬性的簽名資訊。企業使用者需要上傳相關企業資質證明,個人使用者需要上傳證明個人身份的證明。
簡訊簽名需要稽核通過後才可以使用。
簡訊模板
簡訊模板,即具體傳送的簡訊內容。
簡訊模板可以支援驗證碼、簡訊通知、推廣簡訊、國際/港澳臺訊息四種模式。驗證碼和簡訊通知,通過變數替換實現個性簡訊定製。推廣簡訊不支援在模板中新增變數。國際/港澳臺訊息只能使用國際/港澳臺簡訊模版傳送簡訊。
簡訊模板需要稽核通過後才可以使用。
3.引數列表
入參列表
引數名稱 | 引數型別 | 必填與否 | 樣例取值 | 引數說明 |
---|---|---|---|---|
PhoneNumbers | String | 必須 | 15000000000 | 簡訊接收號碼。支援以逗號分隔的形式進行批量呼叫,批量上限為1000個手機號碼,批量呼叫相對於單條呼叫及時性稍有延遲,驗證碼型別的簡訊推薦使用單條呼叫的方式,傳送國際/港澳臺訊息時,接收號碼格式為00+國際區號+號碼,如“0085200000000” |
SignName | String | 必須 | 雲通訊 | 簡訊簽名 |
TemplateCode | String | 必須 | SMS_0000 | 簡訊模板ID,傳送國際/港澳臺訊息時,請使用國際/港澳臺簡訊模版 |
TemplateParam | String | 可選 | {“code”:”1234”,”product”:”ytx”} | 簡訊模板變數替換JSON串,友情提示:如果JSON中需要帶換行符,請參照標準的JSON協議對換行符的要求,比如簡訊內容中包含rn的情況在JSON中需要表示成rn,否則會導致JSON在服務端解析失敗 |
OutId | String | 可選 | abcdefgh | 外部流水擴充套件欄位 |
出參列表
出參名稱 | 出參型別 | 樣例取值 | 引數說明 |
---|---|---|---|
RequestId | String | 8906582E-6722 | 請求ID |
Code | String | OK | 狀態碼-返回OK代表請求成功,其他錯誤碼詳見錯誤碼列表 |
Message | String | 請求成功 | 狀態碼的描述 |
BizId | String | 134523^4351232 | 傳送回執ID,可根據該ID查詢具體的傳送狀態 |
3.介面的下載
- SDK下載
-
執行:
- 安裝依賴:進入根目錄執行命令: python setup.py install #如果為python3,請執行:python3 setup.py install
- 修改資訊:從阿里雲控制檯上獲取ACCESS_KEY_ID與ACCESS_KEY_SECRET,並填入檔案const.py中
- 執行程式:python demo_sms_send.py #如果為python3,請執行python3 demo_sms_send.py
pip install aliyun-python-sdk-core-v3==2.8.6,2.9版本的region_provider沒有add_endpoint屬性 注意:您還需要在控制檯上申請簡訊模板,並將相關資訊填入至檔案demo_sms_send.py中
錯誤碼列表
Code | 描述 |
---|---|
OK | 請求成功 |
isp.RAM_PERMISSION_DENY | RAM許可權DENY |
isv.OUT_OF_SERVICE | 業務停機 |
isv.PRODUCT_UN_SUBSCRIPT | 未開通雲通訊產品的阿里雲客戶 |
isv.PRODUCT_UNSUBSCRIBE | 產品未開通 |
isv.ACCOUNT_NOT_EXISTS | 賬戶不存在 |
isv.ACCOUNT_ABNORMAL | 賬戶異常 |
isv.SMS_TEMPLATE_ILLEGAL | 簡訊模板不合法 |
isv.SMS_SIGNATURE_ILLEGAL | 簡訊簽名不合法 |
isv.INVALID_PARAMETERS | 引數異常 |
isp.SYSTEM_ERROR | 系統錯誤 |
isv.MOBILE_NUMBER_ILLEGAL | 非法手機號 |
isv.MOBILE_COUNT_OVER_LIMIT | 手機號碼數量超過限制 |
isv.TEMPLATE_MISSING_PARAMETERS | 模板缺少變數 |
isv.BUSINESS_LIMIT_CONTROL | 業務限流 |
isv.INVALID_JSON_PARAM | JSON引數不合法,只接受字串值 |
isv.BLACK_KEY_CONTROL_LIMIT | 黑名單管控 |
isv.PARAM_LENGTH_LIMIT | 引數超出長度限制 |
isv.PARAM_NOT_SUPPORT_URL | 不支援URL |
isv.AMOUNT_NOT_ENOUGH | 賬戶餘額不足 |
注:查詢所有錯誤碼及解決辦法請點選簡訊介面呼叫錯誤碼
4.簡訊傳送demo
# -*- coding: utf-8 -*-
# import sys
from aliyunsdkdysmsapi.request.v20170525 import SendSmsRequest
from aliyunsdkdysmsapi.request.v20170525 import QuerySendDetailsRequest
from aliyunsdkcore.client import AcsClient
import uuid
from aliyunsdkcore.profile import region_provider
from aliyunsdkcore.http import method_type as MT
from aliyunsdkcore.http import format_type as FT
import const
"""
簡訊業務呼叫介面示例,版本號:v20170525
Created on 2017-06-12
"""
# 這裡setdefaultencoding為utf8設定預設編碼為utf-8,但是現在可能由於版本原因會出錯
# try:
# reload(sys)
# sys.setdefaultencoding(`utf8`)
# except NameError:
# pass
# except Exception as err:
# raise err
# 注意:不要更改
REGION = "cn-hangzhou"
PRODUCT_NAME = "Dysmsapi"
DOMAIN = "dysmsapi.aliyuncs.com"
#ACCESS_KEY_ID 和ACCESS_KEY_SECRET要傳入
acs_client = AcsClient(ACCESS_KEY_ID, ACCESS_KEY_SECRET, REGION)
region_provider.add_endpoint(PRODUCT_NAME, REGION, DOMAIN)
#這裡寫入自己的簽名和模板,後面呼叫就不用寫了
def send_sms(business_id, phone_numbers,template_param=None,sign_name=`***`,template_code=`***`):
smsRequest = SendSmsRequest.SendSmsRequest()
# 申請的簡訊模板編碼,必填
smsRequest.set_TemplateCode(template_code)
# 簡訊模板變數引數
if template_param is not None:
smsRequest.set_TemplateParam(template_param)
# 設定業務請求流水號,必填。
smsRequest.set_OutId(business_id)
# 簡訊簽名
smsRequest.set_SignName(sign_name)
# 資料提交方式
# smsRequest.set_method(MT.POST)
# 資料提交格式
# smsRequest.set_accept_format(FT.JSON)
# 簡訊傳送的號碼列表,必填。
smsRequest.set_PhoneNumbers(phone_numbers)
# 呼叫簡訊傳送介面,返回json
smsResponse = acs_client.do_action_with_exception(smsRequest)
# TODO 業務處理
return smsResponse
if __name__ == `__main__`:
__business_id = uuid.uuid1()
#print(__business_id)
params = "{"code":"12345","product":"雲通訊"}"
#params = u`{"name":"wqb","code":"12345678","address":"bz","phone":"13000000000"}`
print(send_sms(__business_id, "13000000000", params))
阿里簡訊傳送簡訊時返回這個資訊,之前是可以傳送的,現在阿里應該是做了限制的。如果你的簡訊模板型別為“驗證碼”,傳送的簡訊內容只能是包含字母和數字
所以當你的簡訊內容包含特殊符號和中文時,請把簡訊模板型別修改為“通知”,這裡只能新增一個模板了,因為簡訊模板目前沒有修改。
5.介面的呼叫
class SmsCodeViewset(mixins.CreateModelMixin,viewsets.GenericViewSet):
```
手機驗證碼
```
serializer_class = SmsSerializer
def generate_code(self):
"""
生成四位數字的驗證碼
"""
str1 = ""
for i in range(4):
str1 += str(random.randint(0,9))
return str1
def create(self, request, *args, **kwargs):
serializer = self.get_serializer(data=request.data)
# 驗證合法
serializer.is_valid(raise_exception=True)
mobile = serializer.validated_data["mobile"]
code = self.generate_code()
params = {"code":code}
sms_status = demo_sms_send.send_sms(uuid.uuid1(),mobile,params)
#位元組轉字串
sms_status = sms_status.decode()
#字串轉字典
sms_status = eval(sms_status)
if sms_status["Code"] != "OK":
return Response({
"mobile": sms_status["Message"]
}, status=status.HTTP_400_BAD_REQUEST)
else:
code_record = VerifyCode(code=code, mobile=mobile)
code_record.save()
return Response({
"mobile": mobile
}, status=status.HTTP_201_CREATED)