You need to enable JavaScript to run this app.
导航

Go SDK

最近更新时间2024.02.21 20:23:32

首次发布时间2023.07.04 18:46:58

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

前置准备
  • Go 1.13.1 或更高版本

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

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

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

alt


下载SDK

SDK for Go提供了示例 demo_sms_test.go ,以便开发者可以快速调用SendSms API。
可以根据以下步骤下载SDK:
方式一:
git clone https://github.com/volcengine/volc-sdk-golang.git

方式二:

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

  2. 点击 Code -> Download ZIP

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

    go get -u github.com/volcengine/volc-sdk-golang


设置身份验证
  • 打开示例文件 demo_sms_test.go

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

推荐按照以下方式设置身份验证:

testAk = "testAK" 
testSk = "testSk"

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

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

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

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

使用SendSms API 发送文本短信
  1. 填写demo_sms_test.go正文部分中的参数,如下所示。参数含义请参考SendSms
package main

import (
    "github.com/volcengine/volc-sdk-golang/service/sms"
)

func main() {
    testAk, testSk := "", ""
    sms.DefaultInstance.Client.SetAccessKey(testAk)
    sms.DefaultInstance.Client.SetSecretKey(testSk)
    req := &sms.SmsRequest{
       SmsAccount:    "smsAccount",
       Sign:          "sign",
       TemplateID:    "ST_xxx",
       TemplateParam: "",
       PhoneNumbers:  "188xxxxxxxx",
       Tag:           "tag",
    }
    result, statusCode, err := sms.DefaultInstance.Send(req)
    if err != nil {
       println("sms send err:%s", err.Error())
       return
    }
    println("result is :%s, statusCode is:%d", result, statusCode)
}
  1. 在终端窗口运行以下请求。
go test -v example/demo_sms/demo_sms_test.go

发送结果

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