Python SDK

为方便您更好地使用火山引擎短信服务，我们为开发者封装了SDK for python，开发者可通过下载SDK直接调用短信服务。
以下将以SendSms接口为例，为您介绍如何下载SDK，并调用短信服务向收件人发送短信。

• Python 2.7 或更高版本

• 安装了pip

  • pip是python包管理工具，支持更加方便的安装所需要的库。

• 获取了AK (Access Key) 和 SK (Secret Key)

  • 如果您还没有获取AK/SK，可以通过以下方式获取：火山引擎 -> 账号 -> API访问密钥 -> 新建密钥

小贴士：一个火山引擎账号最多可以同时申请两对 AK/SK 。

SDK for Python提供了示例 example_send_sms.py ，以便开发者可以快速调用SendSms API。

下载SDK

方式一：

1. git clone https://github.com/volcengine/volc-sdk-python.git

方式二：

1. 进入GitHub - volcengine/volc-sdk-python

2. 点击 Code -> Download ZIP

安装SDK

• 在终端窗口运行以下请求来安装SDK for Python

  pip3 install volcengine
  
  

• 打开示例文件 example_send_sms.py

• 通过 AK/SK 设置身份验证。可以按照下面的示例在示例文件中填写您的 AK 和 SK。

推荐按照以下方式设置身份验证ak/sk：

```python
sms_service = SmsService()

sms_service.set_ak('ak')
sms_service.set_sk('sk')
```

或者，您也可以在环境变量设置中填写您的 AK 和 SK，如下所示。

VOLC_ACCESSKEY="your ak"   
VOLC_SECRETKEY="your sk"

否则，您可以通过在～/.volc/credentials 或者～/.volc/config下创建一个JSON文件来设置您的AK和SK，如下所示。

{"ak":"your ak","sk":"your sk"}

1. 填写 example_send_sms.py 正文部分中的参数，如下所示。参数含义请参考SendSms。

# coding:utf-8
from __future__ import print_function

import json

from volcengine.sms.SmsService import SmsService
from volcengine.const.Const import *

if __name__ == '__main__':
    sms_service = SmsService()
    # call below method if you dont set ak and sk in $HOME/.volc/config
    sms_service.set_ak('ak')
    sms_service.set_sk('sk')
    # sms_service.set_host('host')

    body = {
        "SmsAccount": "smsAccount",
        "Sign": "sign",
        "TemplateID": "ST_xxx",
        "TemplateParam": "{\"code\": \"1234\"}",
        "PhoneNumbers": "188xxxxxxxx",
        "Tag": "tag",
    }

    body = json.dumps(body)
    resp = sms_service.send_sms(body)
    print(resp)

    body = {
        "SmsAccount": "smsAccount",
        "Sign": "sign",
        "TemplateID": "ST_xxx",
        "PhoneNumber": "188xxxxxxxx",
        "CodeType": 6,
        "TryCount": 3,
        "ExpireTime": 240,
        "Scene": "Test"
    }
    body = json.dumps(body)
    resp = sms_service.send_sms_verify_code(body)
    print(resp)

    body = {
        "SmsAccount": "smsAccount",
        "PhoneNumber": "188xxxxxxxx",
        "Scene": "Test",
        "Code": "123456"
    }
    body = json.dumps(body)
    resp = sms_service.check_sms_verify_code(body)
    print(resp)

2. 在终端窗口运行以下请求。

python3 example_send_sms.py

短信发送后，您将收到一条包含MessageID的发送成功的响应。响应参数详见SendSms。