腾讯云短信开发
1. 短信服务应用申请
1. 创建短信应用 - 应用管理
2. 申请短信签名 - 国内短信 > 签名管理
3. 申请短信模块 - 国内短信 > 正文模板管理
2.python中开发腾讯云短信服务
1. API文档,接口的使用说吧
2. SDK,基于开发语言封装的可以直接调用的功能(工具)集合 官网sdk使用文档中找到安装命令:pip install qcloudsms_py 按照sdk使用说明进行开发:https://cloud.tencent.com/document/product/382/11672
API和SDK的区别:
- API:网络地址,有请求方式,向这个地址按照规则发送请求,就能完成某些操作---》以后只要使用第三方服务,大概率会提供给你api
- sdk:集成开发工具包,第三方平台,用不同语言对api接口进行封装---》只要按照它的使用规则---》直接导入使用接口
- 可能没提供所有语言的sdk,不同语言要单独写
- python的形式就是一个 包,把包下载下来
- 以后使用第三方,如果有sdk,优先用sdk,如果没有,只能用api
下载sdk:pip install --upgrade tencentcloud-sdk-python
请求流程:
3. 发送短信功能
# -*- coding: utf-8 -*- import json from tencentcloud.common import credential from tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException # 导入对应产品模块的client models。 from tencentcloud.sms.v20210111 import sms_client, models # 导入可选配置类 from tencentcloud.common.profile.client_profile import ClientProfile from tencentcloud.common.profile.http_profile import HttpProfile try: # 必要步骤: # 实例化一个认证对象,入参需要传入腾讯云账户密钥对secretId,secretKey。 # 这里采用的是从环境变量读取的方式,需要在环境变量中先设置这两个值。 # 您也可以直接在代码中写死密钥对,但是小心不要将代码复制、上传或者分享给他人, # 以免泄露密钥对危及您的财产安全。 # SecretId、SecretKey 查询: https://console.cloud.tencent.com/cam/capi cred = credential.Credential("AKIDYjmcalqjdYWKvOp9FAta7fDalmaMDxVr", "FJFzVokVHxKdowooiYKySwJg3QmxudCa") # 实例化一个http选项,可选的,没有特殊需求可以跳过。 httpProfile = HttpProfile() # 如果需要指定proxy访问接口,可以按照如下方式初始化hp(无需要直接忽略) # httpProfile = HttpProfile(proxy="http://用户名:密码@代理IP:代理端口") httpProfile.reqMethod = "POST" # post请求(默认为post请求) httpProfile.reqTimeout = 30 # 请求超时时间,单位为秒(默认60秒) httpProfile.endpoint = "sms.tencentcloudapi.com" # 指定接入地域域名(默认就近接入) clientProfile = ClientProfile() # 实例化要请求产品(以sms为例)的client对象 # 第二个参数是地域信息,可以直接填写字符串ap-guangzhou,支持的地域列表参考 https://cloud.tencent.com/document/api/382/52071#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8 client = sms_client.SmsClient(cred, "ap-guangzhou", clientProfile) req = models.SendSmsRequest() # 基本类型的设置: # SDK采用的是指针风格指定参数,即使对于基本类型您也需要用指针来对参数赋值。 # SDK提供对基本类型的指针引用封装函数 # 帮助链接: # 短信控制台: https://console.cloud.tencent.com/smsv2 # 腾讯云短信小助手: https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81 # 短信应用ID: 短信SdkAppId在 [短信控制台] 添加应用后生成的实际SdkAppId,示例如1400006666 # 应用 ID 可前往 [短信控制台](https://console.cloud.tencent.com/smsv2/app-manage) 查看 req.SmsSdkAppId = "1400861074" # 短信签名内容: 使用 UTF-8 编码,必须填写已审核通过的签名 # 签名信息可前往 [国内短信](https://console.cloud.tencent.com/smsv2/csms-sign) 或 [国际/港澳台短信](https://console.cloud.tencent.com/smsv2/isms-sign) 的签名管理查看 req.SignName = "花花的万事屋公众号" # 模板 ID: 必须填写已审核通过的模板 ID # 模板 ID 可前往 [国内短信](https://console.cloud.tencent.com/smsv2/csms-template) 或 [国际/港澳台短信](https://console.cloud.tencent.com/smsv2/isms-template) 的正文模板管理查看 req.TemplateId = "1952813" # 模板参数: 模板参数的个数需要与 TemplateId 对应模板的变量个数保持一致,,若无模板参数,则设置为空 req.TemplateParamSet = ["520", '10'] # 下发手机号码,采用 E.164 标准,+[国家或地区码][手机号] # 示例如:+8613711112222, 其中前面有一个+号 ,86为国家码,13711112222为手机号,最多不要超过200个手机号 req.PhoneNumberSet = ["+8618136943254"] # 用户的 session 内容(无需要可忽略): 可以携带用户侧 ID 等上下文信息,server 会原样返回 req.SessionContext = "" # 短信码号扩展号(无需要可忽略): 默认未开通,如需开通请联系 [腾讯云短信小助手] req.ExtendCode = "" # 国内短信无需填写该项;国际/港澳台短信已申请独立 SenderId 需要填写该字段,默认使用公共 SenderId,无需填写该字段。注:月度使用量达到指定量级可申请独立 SenderId 使用,详情请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。 req.SenderId = "" resp = client.SendSms(req) # 输出json格式的字符串回包 print(resp.to_json_string(indent=2)) # 当出现以下错误码时,快速解决方案参考 # - [FailedOperation.SignatureIncorrectOrUnapproved](https://cloud.tencent.com/document/product/382/9558#.E7.9F.AD.E4.BF.A1.E5.8F.91.E9.80.81.E6.8F.90.E7.A4.BA.EF.BC.9Afailedoperation.signatureincorrectorunapproved-.E5.A6.82.E4.BD.95.E5.A4.84.E7.90.86.EF.BC.9F) # - [FailedOperation.TemplateIncorrectOrUnapproved](https://cloud.tencent.com/document/product/382/9558#.E7.9F.AD.E4.BF.A1.E5.8F.91.E9.80.81.E6.8F.90.E7.A4.BA.EF.BC.9Afailedoperation.templateincorrectorunapproved-.E5.A6.82.E4.BD.95.E5.A4.84.E7.90.86.EF.BC.9F) # - [UnauthorizedOperation.SmsSdkAppIdVerifyFail](https://cloud.tencent.com/document/product/382/9558#.E7.9F.AD.E4.BF.A1.E5.8F.91.E9.80.81.E6.8F.90.E7.A4.BA.EF.BC.9Aunauthorizedoperation.smssdkappidverifyfail-.E5.A6.82.E4.BD.95.E5.A4.84.E7.90.86.EF.BC.9F) # - [UnsupportedOperation.ContainDomesticAndInternationalPhoneNumber](https://cloud.tencent.com/document/product/382/9558#.E7.9F.AD.E4.BF.A1.E5.8F.91.E9.80.81.E6.8F.90.E7.A4.BA.EF.BC.9Aunsupportedoperation.containdomesticandinternationalphonenumber-.E5.A6.82.E4.BD.95.E5.A4.84.E7.90.86.EF.BC.9F) # - 更多错误,可咨询[腾讯云助手](https://tccc.qcloud.com/web/im/index.html#/chat?webAppId=8fa15978f85cb41f7e2ea36920cb3ae1&title=Sms) except TencentCloudSDKException as err: print(err)
4. 发送短信封装
4.1 目录结构
# SecretId、SecretKey 查询: https://console.cloud.tencent.com/cam/capi SECRET_ID = 'SecretId' SECRET_KEY = 'SecretKey' APPID = '应用 ID' SIGN_NAME = '签名内容' TEMPLATE_ID = '模板 ID '
如图:
4.2 sms.py
from tencentcloud.common import credential from tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException # 导入对应产品模块的client models。 from tencentcloud.sms.v20210111 import sms_client, models # 导入可选配置类 from tencentcloud.common.profile.client_profile import ClientProfile from tencentcloud.common.profile.http_profile import HttpProfile from . import settings import random import json # 1,生成一个随机验证码 def get_code(number=4): code = '' for i in range(number): r_code = random.randint(0, 9) code += str(r_code) return code # 2. 传入手机号和验证码,发送短信功能函数 def send_sms(code, mobile): try: cred = credential.Credential(settings.SECRET_ID,settings.SECRET_KEY) httpProfile = HttpProfile() httpProfile.reqMethod = "POST" # post请求(默认为post请求) httpProfile.reqTimeout = 30 # 请求超时时间,单位为秒(默认60秒) httpProfile.endpoint = "sms.tencentcloudapi.com" # 指定接入地域域名(默认就近接入) clientProfile = ClientProfile() clientProfile.signMethod = "TC3-HMAC-SHA256" # 指定签名算法 clientProfile.language = "en-US" clientProfile.httpProfile = httpProfile # 实例化要请求产品(以sms为例)的client对象 client = sms_client.SmsClient(cred, "ap-guangzhou", clientProfile) req = models.SendSmsRequest() req.SmsSdkAppId = settings.APPID req.SignName = settings.SIGN_NAME req.TemplateId = settings.TEMPLATE_ID req.TemplateParamSet = [code, "10"] req.PhoneNumberSet = ["+86"+mobile] resp = client.SendSms(req) # 输出json格式的字符串回包 response_data_dict = json.loads(resp.to_json_string(indent=2)) if response_data_dict.get('SendStatusSet')[0].get('Code')=='Ok': return True else: return False except TencentCloudSDKException as err: # print(err) return False # 做随机验证码的测试: if __name__ == '__main__': print(get_code())
5. 短信验证码接口
from django.utils.datastructures import MultiValueDictKeyError from rest_framework.viewsets import ViewSet from rest_framework.decorators import action from utils.common_response import APIResponse from .models import User from .serializer import UserLoginSerializer, SMSLoginSerializer from libs.tx_sms.sms import get_code, send_sms as send_sms_mobile # 防止和下面的send_sms方法冲突 from django.core.cache import cache from threading import Thread # 验证手机号是否存在接口 class MobileView(ViewSet): @action(methods=['GET'], detail=False) def check_mobile(self, request, *args, **kwargs): try: # 取出前端传入的手机哈 mobile = request.query_params['mobile'] User.objects.get(mobile=mobile) # 有且只有一个才不报错,否则报错 except MultiValueDictKeyError as e: raise Exception('您没有携带手机号') except Exception as e: raise Exception('未知错误,请联系管理员') return APIResponse(msg='手机号已存在') # 短信验证码接口 @action(methods=['POST'], detail=False) def send_sms(self, request, *args, **kwargs): # 1.手机号从前端传入:{mobile:1351150} mobile = request.data.get('mobile') # 2. 生成数字验证码 code = get_code() # 3. 将数字验证码保存,放到缓存中保存,默认放在内存里,下次使用时进行比较 cache.set('cache_mobile_%s' % mobile, code) # 4. 发送短信 ---》 同步操作 ----》前端可以会一直等待,耗时 # 5. 发送短信 ---》异步操作,使用多线程,无法知道短信是否成功了,不需要关注是否成功 t = Thread(target=send_sms_mobile, args=[code, mobile]) t.start() return APIResponse(msg='短信已发送')
如图:
简单测试:
6. 短信登录接口
分析:
前端携带的数据---》{mobile:11111,code:8888}
后端:
-取出手机号验证码,验证验证码是否正确,如果正确
-签发token
-返回给前端
视图类:
from rest_framework.decorators import action from utils.common_response import APIResponse from rest_framework.viewsets import GenericViewSet from .serializer import UserLoginSerializer, SMSLoginSerializer # 多方式登录接口 class UserLoginView(GenericViewSet): serializer_class = UserLoginSerializer # 普通方式登录 @action(methods=['POST'], detail=False) def mul_login(self, request, *args, **kwargs): return self._login(request, *args, **kwargs) # 使用的序列化类是UserLoginSerializer # 短信登录 @action(methods=['POST']) def sms_login(self, request, *args, **kwargs): return self._login(request, *args, **kwargs) # 使用的序列化类不一样,使用的是SMSLoginSerializer def get_serializer_class(self): # 根据不同的地址判断,使用不同的序列化类:如果是短信登录的,就返回短信登录的序列化类,其他情况就返回UserLoginSerializer if self.action == 'sms_login': return SMSLoginSerializer elif self.action == 'mul_login': return UserLoginSerializer else: return super().get_serializer_class() # 只在内部使用 def _login(self, request, *args, **kwargs): ser = self.get_serializer(data=request.data) # 序列化类不一样,重写某个方法,实现,不同的请求action,返回的序列化类不一样 ser.is_valid(raise_exception=True) username = ser.context.get('username') token = ser.context.get('token') icon = ser.context.get('icon') return APIResponse(username=username, token=token, icon=icon)
如图:
序列化类:
from rest_framework import serializers from rest_framework_jwt.serializers import jwt_payload_handler, jwt_encode_handler import re from rest_framework.exceptions import ValidationError from .models import User from django.conf import settings from django.core.cache import cache # 将重复的代码提取出来放在这个序列化类中,后面的序列化类继承就可以了 class LoginSerializer(serializers.Serializer): def validate(self, attrs): # 1. 校验用户 user = self._get_user(attrs) # attrs:是前端传入校验过后的数据对象 # 2.签发token token = self._get_token(user) # 将签发的token和username放到context中 self.context['username'] = user.username self.context['token'] = token self.context['icon'] = settings.BACKEND_URL + '/media/' + str(user.icon) # 返回attrs return attrs def _get_user(self, attrs): username = attrs.get('username') password = attrs.get('password') # 进行正则匹配 if re.match(r'^1[3-9][0-9]{9}', username): user = User.objects.filter(mobile=username).first() elif re.match(r'^[a-zA-Z0-9_-]+@[a-zA-Z0-9_-]+(.[a-zA-Z0-9_-]+)+$', username): user = User.objects.filter(email=username).first() else: user = User.objects.filter(username=username).first() # 因为数据库中的password是密文,前端提交的密码是明文,所以使用check_password if user and user.check_password(password): return user else: raise ValidationError('用户名或密码错误') def _get_token(self, user): payload = jwt_payload_handler(user) token = jwt_encode_handler(payload) return token # 普通登录 class UserLoginSerializer(LoginSerializer): # 要重写字段,因为字段自己的规则通不过,因为unique username = serializers.CharField() password = serializers.CharField() def _get_user(self, attrs): username = attrs.get('username') password = attrs.get('password') # 进行正则匹配 if re.match(r'^1[3-9][0-9]{9}', username): user = User.objects.filter(mobile=username).first() elif re.match(r'^[a-zA-Z0-9_-]+@[a-zA-Z0-9_-]+(.[a-zA-Z0-9_-]+)+$', username): user = User.objects.filter(email=username).first() else: user = User.objects.filter(username=username).first() # 因为数据库中的password是密文,前端提交的密码是明文,所以使用check_password if user and user.check_password(password): return user else: raise ValidationError('用户名或密码错误') # 短信登录 class SMSLoginSerializer(LoginSerializer): mobile = serializers.CharField() code = serializers.CharField() # 校验code是否正确,从cache中取值 def _get_user(self, attrs): mobile = attrs.get('mobile') code = attrs.get('code') # 1 校验code是否正确 old_code = cache.get('cache_mobile_%s' % mobile) if old_code == code: # 2 根据手机号,取到用户 user = User.objects.filter(mobile=mobile).first() if user: return user else: raise ValidationError('手机号不存在') else: raise ValidationError('验证码错误')
简单测试:
补充:
短信登录或注册接口
- app 只要输入手机号 和验证码 ,如果账号不存在,直接注册成功 ,并且登录成功,如果账号存在,就是登录
- 前端传入:{mobile,code} --->验证 验证码是否正确 ---》 拿着mobile 去数据库查询,如果能查到,说明它注册过了,直接签发token 返回 ---》 如果查不到,没有注册过 ---》 走注册逻辑完成注册 ---》在签发token,返回给前端
- 这个接口,随机生成 一个 6为密码 ,以短信形式通知用户
- 这个接口,密码为空,下次他用账号密码登录,不允许登录
- 后续改密码:user.set_pasword(new_password)
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 被坑几百块钱后,我竟然真的恢复了删除的微信聊天记录!
· 没有Manus邀请码?试试免邀请码的MGX或者开源的OpenManus吧
· 【自荐】一款简洁、开源的在线白板工具 Drawnix
· 园子的第一款AI主题卫衣上架——"HELLO! HOW CAN I ASSIST YOU TODAY
· Docker 太简单,K8s 太复杂?w7panel 让容器管理更轻松!