Go SDK

1. 前提条件

在安装和使用Go SDK前,确保您已经:
  • 安装Go环境
  • 已经注册云通讯账号且已获取auth token,并已开通应用

2. Go SDK使用说明

2.1 本地安装SDK
  • go get -u github.com/cloopen/go-sms-sdk/cloopen
2.2 自定义配置及默认
  • WithAPIAccount(xxx) 配置主账号 需调用者初始化此值
  • WithAPIToken(xxx) 配置主账号令牌 需调用者初始化此值
  • WithSmsHost(xxx) 配置ip:port 默认 app.cloopen.com:8883
  • WithUseSSL(true) 配置是否使用https 默认启用https
  • WithHTTPClient(customHttp) 配置自定义httpClient 默认使用sdk封装的httpClient
  • WithHttpConf(&HttpConf{...}) 配置sdk封装的httpClient可调整参数 默认使用sdk封装的httpClient参数
2.3 参考HttpConf默认配置
  • // 时间单位为毫秒&HttpConf{
  •    Timeout:             300,
  •    KeepAlive:           30000,
  •    MaxIdleConns:        100,
  •    IdleConnTimeout:     30000,
  •    TLSHandshakeTimeout: 300,
  • }
2.4 方法调用
  • cloopen.NewJsonClient(cfg) json 格式包体使用此方法
  • cloopen.NewXmlClient(cfg) xml 格式包体使用此方法

3. 源码说明

  • sdk
    • config.go 接口基础配置
    • client.go 客户端定义、配置
    • fields.go 常量定义
    • sms.go 短信功能
    • util.go 工具函数

4. Go SDK GitHub地址

5. 调用示例

  • package main
  • import (
  •  "github.com/cloopen/go-sms-sdk/cloopen"
  •  "log"
  • )
  • func main() {
  •  cfg := cloopen.DefaultConfig().
  •   // 开发者主账号,登陆云通讯网站后,可在控制台首页看到开发者主账号ACCOUNT SID和主账号令牌AUTH TOKEN
  •   WithAPIAccount("accountSId").
  •   // 主账号令牌 TOKEN,登陆云通讯网站后,可在控制台首页看到开发者主账号ACCOUNT SID和主账号令牌AUTH TOKEN
  •   WithAPIToken("auth token")
  •  sms := cloopen.NewJsonClient(cfg).SMS()
  •  // 下发包体参数
  •  input := &cloopen.SendRequest{
  •   // 应用的APPID
  •   AppId: "appId",
  •   // 手机号码
  •   To: "1352*******",
  •   // 模版ID
  •   TemplateId: "templateId",
  •   // 模版变量内容 非必填
  •   Datas: []string{"您的验证码是****"},
  •  }
  •  // 下发
  •  resp, err := sms.Send(input)
  •  if err != nil {
  •   log.Fatal(err)
  •   return
  •  }
  •  log.Printf("Response MsgId: %s \n", resp.TemplateSMS.SmsMessageSid)

  • }