easysms详解——华为云模板短信

一、简介

easysms是一个易于使用的短信服务API，它提供了发送短信、查询短信发送状态、查询短信余额、拉取短信回执等功能。本文将以华为云模板短信作为案例，深入剖析easysms的各种用法及相关配置。

二、easysms进阶

1、发送短信

使用easysms发送短信非常简单，只需如下代码即可：

from huaweisms import HuaweiSms

sms = HuaweiSms('access_key', 'secret_key', endpoint='https://apiendpoint')

response = sms.send_sms(
    message='你的验证码是123456',
    to=['+8613800110000'],
    sender='123456',
    signature='华为云短信',
    template_id='Your template id',
    template_data={
        'code': '123456',
    }
 )

其中，access_key和secret_key是你的华为云访问密钥，endpoint默认为华为云API端点地址，message是短信内容，to是收件人号码，sender是自定义短信签名，signature是你在华为云控制台上设置的短信签名，template_id是你在控制台上创建的短信模板ID，template_data是你要传递的短信模板变量。

2、查询短信发送状态

使用easysms查询短信发送状态也很方便，如下代码所示：

sms = HuaweiSms('access_key', 'secret_key', endpoint='https://apiendpoint')

response = sms.query_sms_status(['sms_message_uuid'])

其中sms_message_uuid是发送短信API返回的短信ID，也可以传递一个列表来查询多个短信。

3、查询短信余额

查询短信余额同样也很简单，如下代码所示：

sms = HuaweiSms('access_key', 'secret_key', endpoint='https://apiendpoint')

response = sms.get_sms_balance()

该API返回账户的短信余额和短信计费规则。

4、拉取短信回执

使用easysms拉取短信回执也是非常容易的，如下代码所示：

sms = HuaweiSms('access_key', 'secret_key', endpoint='https://apiendpoint')

response = sms.pull_sms_receipt(reply_limit=10)

其中，reply_limit表示本次调用想要获取的最多回执数，如果不指定则默认返回所有回执。

三、华为云模板短信

1、创建短信签名

在使用模板短信之前，我们需要先创建短信签名。在华为云控制台上进入短信服务管理，选择签名管理，进入创建签名页面，选择类型为企事业单位或政府机关，填写短信签名并提交审核。

2、创建短信模板

在创建完成短信签名之后，我们还需进入短信模板管理，进入新建模板页面。填写模板名称、签名名称、短信内容，注意短信模板内容中需要添加模板变量，一般使用{{变量名}}的形式，例如：

【签名名称】您的验证码是{{code}}，有效期{{expire}}分钟，请勿泄漏于他人。

3、华为云模板短信相关代码示例

下面的代码示例演示了如何使用easysms发送华为云模板短信：

from huaweisms import HuaweiSms

sms = HuaweiSms('access_key', 'secret_key', endpoint='https://apiendpoint')

response = sms.send_template_sms(
    template_id='Your template id',
    to=['+8613800110000', '+8613800110001'],
    signature='华为云短信',
    template_data={
        'code': '123456',
        'expire': '5',
    }
 )

通过调用send_template_sms方法，指定华为云模板短信ID、收件人号码、签名和模板变量即可发送模板短信。

4、小结

easysms是一个简单易用的短信服务API，提供了发送短信、查询短信发送状态、查询短信余额、拉取短信回执等多种使用方式。通过上述案例，我们还了解了如何在华为云控制台上创建短信签名和模板，并使用easysms发送华为云模板短信。