本文为您介绍Python调用短信发送API的操作流程。

发送短信接口（SendSms）

注意 使用短信服务新版SDK调用API接口，请查看新版SDK参考和API参考。

本接口主要适用于短信单发场景，特殊场景下可支持群发（最多可向1000个手机号码发送同样内容的短信），但群发会有一定延迟。

步骤1：创建阿里云账号

为了访问短信服务，您需要有一个阿里云账号。如果没有，可首先按照如下步骤创建阿里云账号：

  1. 访问阿里云官方网站，单击页面上的免费注册按钮。
  2. 按照屏幕提示完成注册流程并进行实名认证， 短信服务只支持实名认证用户使用。 为了更好地使用阿里云服务，建议尽快完成实名认证，否则部分阿里云服务将无法使用。具体实名认证流程，请参见这里。

步骤2： 获取阿里云访问密钥

为了使用短信发送API-Python SDK，您必须申请阿里云的访问密钥。

阿里云访问秘钥是阿里云为用户使用 API（非控制台）来访问其云资源设计的“安全口令”。您可以用它来签名 API 请求内容以通过服务端的安全验证。

该访问秘钥成对（AccessKeyId 与 AccessKeySecret）生成和使用。每个阿里云用户可以创建多对访问秘钥，且可随时启用（Active）、禁用（Inactive）或者删除已经生成的访问秘钥对。

您可以通过阿里云控制台的秘钥管理页面创建、管理所有的访问秘钥对，且保证它处于“启用”状态。由于访问秘钥是阿里云对 API 请求进行安全验证的关键因子，请妥善保管你的访问秘钥。如果某些秘钥对出现泄漏风险，建议及时删除该秘钥对并生成新的替代秘钥对。

步骤3：在控制台完成模板与签名的申请，获得调用接口必备的参数

短信签名

根据用户属性来创建符合自身属性的签名信息。企业用户需要上传相关企业资质证明，个人用户需要上传证明个人身份的证明。

说明 短信签名需要审核通过后才可以使用。

短信模板

短信模板，即具体发送的短信内容。

短信模板可以支持验证码、短信通知、推广短信、国际/港澳台消息四种模式。验证码和短信通知，通过变量替换实现个性短信定制。推广短信不支持在模板中添加变量。国际/港澳台消息只能使用国际/港澳台短信模版发送短信。

说明 短信模板需要审核通过后才可以使用。

为了成功发送一条短信通知，您至少需要完成以下步骤

  1. 在控制台完成短信签名与短信模板的申请，获得调用接口必备的参数。
  2. 在“短信签名”页面完成签名的申请，获得短信签名的字符串 签名申请手册。
  3. 在“短信模板”页面完成模板的申请，获得模板ID。模板申请手册。

入参列表

参数名称 参数类型 必填与否 样例取值 参数说明
PhoneNumbers String 必须 1500000**** 短信接收号码。支持以逗号分隔的形式进行批量调用，批量上限为1000个手机号码，批量调用相对于单条调用及时性稍有延迟，验证码类型的短信推荐使用单条调用的方式，发送国际/港澳台消息时，接收号码格式为：国际区号+号码，如“8520000****”。
SignName String 必须 云通信 短信签名。
TemplateCode String 必须 SMS_0000 短信模板ID，发送国际/港澳台消息时，请使用国际/港澳台短信模版。
TemplateParam String 可选 {"code":"1234","product":"ytx"} 短信模板变量替换JSON串，友情提示：如果JSON中需要带换行符，请参照标准的JSON协议对换行符的要求，比如短信内容中包含\r\n的情况在JSON中需要表示成\r\n，否则会导致JSON在服务端解析失败。
OutId String 可选 abcdefgh 外部流水扩展字段。

出参列表

出参名称 出参类型 样例取值 参数说明
RequestId String 8906582E-6722 请求ID。
Code String OK 状态码-返回OK代表请求成功，其他错误码详见错误码列表。
Message String 请求成功 状态码的描述。
BizId String 134523^4351232 发送回执ID，可根据该ID查询具体的发送状态。

技术对接步骤

  • python版本要求：python 2.6+, python3.x

  • 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
    注意 您还需要在控制台上申请短信模板，并将相关信息填入至文件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 账户余额不足。
说明 查询所有错误码及解决办法，请参见短信接口调用错误码。

时间戳格式：

格式为：yyyy-MM-dd’T’HH:mm:ss’Z’；时区为：GMT。