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發送華為雲模板短訊。