tencent cloud

文档反馈

最后更新时间:2024-06-27 15:48:01
    SDK 3.0是云 API 3.0平台的配套工具,您可以通过 SDK 使用所有 短信 API。新版 SDK 实现了统一化,具有各个语言版本的 SDK 使用方法相同,接口调用方式相同,错误码相同以及返回包格式相同等优点。
    注意:
    接入国际站要求的接口版本。
    接入国际站需要使用短信 API 2021-01-11 版本,可参考示例代码。
    发送短信相关接口。
    一次群发请求最多支持200个号码。
    签名、正文模板相关接口。
    个人认证用户不支持使用签名、正文模板相关接口,只能通过短信控制台 管理短信签名管理短信正文模板。如需使用该类接口,请将 “个人认证” 变更为 “企业认证”。

    前提条件

    了解 地域 概念,选择需求的地域接入。
    已开通短信服务,具体操作请参见 国际/港澳台短信快速入门
    已在访问管理控制台 > API 密钥管理 页面获取 SecretID 和 SecretKey。
    SecretID 用于标识 API 调用者的身份。
    SecretKey 用于加密签名字符串和服务器端验证签名字符串的密钥,SecretKey 需妥善保管,避免泄露
    短信的调用地址为sms.tencentcloudapi.com

    相关资料

    各个接口及其参数的详细介绍请参见 API 文档
    下载 SDK 源码请访问 Github 仓库 或者 Gitee 仓库

    安装 SDK

    通过 go get 安装(推荐)

    Github 仓库参见:通过 go get 安装(推荐)
    Gitee 仓库参见:通过 go get 安装(推荐)

    通过源码安装

    Github 仓库参见:通过源码安装
    Gitee 仓库参见:通过源码安装

    示例代码

    说明:
    所有示例代码仅作参考,无法直接编译和运行,需根据实际情况进行修改,您也可以根据实际需求使用 API 3.0 Explorer 自动化生成 Demo 代码。
    每个接口都有一个对应的 Request 结构和一个 Response 结构。本文仅列举几个常用功能的示例代码,如下所示。

    发送短信

    package main
    
    import (
    "encoding/json"
    "fmt"
    "os"
    
    "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common"
    "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/errors"
    "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/profile"
    sms "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/sms/v20210111" // 引入sms
    )
    
    func main() {
    // 必要步骤:
    // 实例化一个认证对象,入参需要传入腾讯云账户密钥对 SecretId,SecretKey。
    // 硬编码密钥到代码中有可能随代码泄露而暴露,有安全隐患,并不推荐。
    // 为了保护密钥安全,建议将密钥设置在环境变量中或者配置文件中。
    // SecretId、SecretKey 查询: https://console.tencentcloud.com/cam/capi
    // credential := common.NewCredential("SecretId", "SecretKey")
    credential := common.NewCredential(
    os.Getenv("TENCENTCLOUD_SECRET_ID"),
    os.Getenv("TENCENTCLOUD_SECRET_KEY"),
    )
    /* 非必要步骤:
    * 实例化一个客户端配置对象,可以指定超时时间等配置 */
    cpf := profile.NewClientProfile()
    
    /* SDK默认使用POST方法。
    * 如果你一定要使用GET方法,可以在这里设置。GET方法无法处理一些较大的请求 */
    cpf.HttpProfile.ReqMethod = "POST"
    cpf.HttpProfile.ReqTimeout = 10 // 请求超时时间,单位为秒(默认60秒)
    /* 指定接入地域域名,默认就近地域接入域名为 sms.tencentcloudapi.com ,也支持指定地域域名访问,例如新加坡地域的域名为 sms.ap-singapore.tencentcloudapi.com */
    cpf.HttpProfile.Endpoint = "sms.tencentcloudapi.com"
    
    /* SDK默认用TC3-HMAC-SHA256进行签名,非必要请不要修改这个字段 */
    cpf.SignMethod = "HmacSHA1"
    
    /* 实例化要请求产品(以sms为例)的client对象
    * 第二个参数是地域信息,根据您选择的国际站地域,如您选择的是新加坡国际站,则应该填入字符串ap-singapore,地域列表可参考https://www.tencentcloud.com/document/api/382/40466?lang=en#region-list */
    client, _ := sms.NewClient(credential, "ap-singapore", cpf)
    
    /* 实例化一个请求对象,根据调用的接口和实际情况,可以进一步设置请求参数
    * 你可以直接查询SDK源码确定接口有哪些属性可以设置
    * 属性可能是基本类型,也可能引用了另一个数据结构
    * 推荐使用IDE进行开发,可以方便的跳转查阅各个接口和数据结构的文档说明 */
    request := sms.NewSendSmsRequest()
    
    /* 基本类型的设置:
    * SDK采用的是指针风格指定参数,即使对于基本类型你也需要用指针来对参数赋值。
    * SDK提供对基本类型的指针引用封装函数
    * 帮助链接:
    * 短信控制台: https://console.tencentcloud.com/smsv2
    * sms helper: https://www.tencentcloud.com/document/product/382/3773 */
    
    /* 短信应用ID: 短信SdkAppId在 [短信控制台] 添加应用后生成的实际SdkAppId,示例如2400006666 */
    request.SmsSdkAppId = common.StringPtr("2400006666")
    /* 短信签名内容: 使用 UTF-8 编码,必须填写已审核通过的签名,签名信息可登录 [短信控制台] 查看 */
    request.SignName = common.StringPtr("xxx")
    /* 国际/港澳台短信 SenderId: 中国大陆地区短信填空,默认未开通,如需开通请联系 [sms helper] */
    request.SenderId = common.StringPtr("")
    /* 用户的 session 内容: 可以携带用户侧 ID 等上下文信息,server 会原样返回 */
    request.SessionContext = common.StringPtr("xxx")
    /* 短信码号扩展号: 默认未开通,如需开通请联系 [sms helper] */
    request.ExtendCode = common.StringPtr("")
    /* 模板参数: 若无模板参数,则设置为空*/
    request.TemplateParamSet = common.StringPtrs([]string{"0"})
    /* 模板 ID: 必须填写已审核通过的模板 ID。模板ID可登录 [短信控制台] 查看 */
    request.TemplateId = common.StringPtr("449739")
    /* 下发手机号码,采用 E.164 标准,+[国家或地区码][手机号]
    * 示例如:+60198890000, 其中前面有一个+号 ,60为国家码,198890000为手机号,最多不要超过200个手机号*/
    request.PhoneNumberSet = common.StringPtrs([]string{"+60198890000"})
    
    // 通过client对象调用想要访问的接口,需要传入请求对象
    response, err := client.SendSms(request)
    // 处理异常
    if _, ok := err.(*errors.TencentCloudSDKError); ok {
    fmt.Printf("An API error has returned: %s", err)
    return
    }
    // 非SDK异常,直接失败。实际代码中可以加入其他的处理。
    if err != nil {
    panic(err)
    }
    b, _ := json.Marshal(response.Response)
    // 打印返回的json字符串
    fmt.Printf("%s", b)
    }

    拉取回执状态

    package main
    
    import (
    "encoding/json"
    "fmt"
    "os"
    
    "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common"
    "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/errors"
    "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/profile"
    sms "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/sms/v20210111" // 引入sms
    )
    
    func main() {
    // 必要步骤:
    // 实例化一个认证对象,入参需要传入腾讯云账户密钥对 SecretId,SecretKey。
    // 硬编码密钥到代码中有可能随代码泄露而暴露,有安全隐患,并不推荐。
    // 为了保护密钥安全,建议将密钥设置在环境变量中或者配置文件中。
    // SecretId、SecretKey 查询: https://console.tencentcloud.com/cam/capi
    // credential := common.NewCredential("SecretId", "SecretKey")
    credential := common.NewCredential(
    os.Getenv("TENCENTCLOUD_SECRET_ID"),
    os.Getenv("TENCENTCLOUD_SECRET_KEY"),
    )
    /* 非必要步骤:
    * 实例化一个客户端配置对象,可以指定超时时间等配置 */
    cpf := profile.NewClientProfile()
    
    /* SDK默认使用POST方法。
    * 如果你一定要使用GET方法,可以在这里设置。GET方法无法处理一些较大的请求 */
    cpf.HttpProfile.ReqMethod = "POST"
    cpf.HttpProfile.ReqTimeout = 30 // 请求超时时间,单位为秒(默认60秒)
    /* 指定接入地域域名,默认就近地域接入域名为 sms.tencentcloudapi.com ,也支持指定地域域名访问,例如新加坡地域的域名为 sms.ap-singapore.tencentcloudapi.com */
    cpf.HttpProfile.Endpoint = "sms.tencentcloudapi.com"
    
    /* SDK默认用TC3-HMAC-SHA256进行签名
    * 非必要请不要修改这个字段 */
    cpf.SignMethod = "HmacSHA1"
    
    /* 实例化要请求产品(以sms为例)的client对象
    * 第二个参数是地域信息,根据您选择的国际站地域,如您选择的是新加坡国际站,则应该填入字符串ap-singapore,地域列表可参考https://www.tencentcloud.com/document/api/382/40466?lang=en#region-list */
    client, _ := sms.NewClient(credential, "ap-singapore", cpf)
    
    /* 实例化一个请求对象,根据调用的接口和实际情况,可以进一步设置请求参数
    * 你可以直接查询SDK源码确定接口有哪些属性可以设置
    * 属性可能是基本类型,也可能引用了另一个数据结构
    * 推荐使用IDE进行开发,可以方便的跳转查阅各个接口和数据结构的文档说明 */
    request := sms.NewPullSmsSendStatusRequest()
    
    /* 基本类型的设置:
    * SDK采用的是指针风格指定参数,即使对于基本类型你也需要用指针来对参数赋值。
    * SDK提供对基本类型的指针引用封装函数
    * 帮助链接:
    * 短信控制台: https://console.tencentcloud.com/smsv2
    * sms helper: https://www.tencentcloud.com/document/product/382/3773 */
    
    /* 短信应用ID: 短信SdkAppId在 [短信控制台] 添加应用后生成的实际SdkAppId,示例如2400006666 */
    request.SmsSdkAppId = common.StringPtr("2400006666")
    /* 拉取最大条数,最多100条 */
    request.Limit = common.Uint64Ptr(10)
    
    // 通过client对象调用想要访问的接口,需要传入请求对象
    response, err := client.PullSmsSendStatus(request)
    // 处理异常
    if _, ok := err.(*errors.TencentCloudSDKError); ok {
    fmt.Printf("An API error has returned: %s", err)
    return
    }
    // 非SDK异常,直接失败。实际代码中可以加入其他的处理。
    if err != nil {
    panic(err)
    }
    b, _ := json.Marshal(response.Response)
    // 打印返回的json字符串
    fmt.Printf("%s", b)
    }

    统计短信发送数据

    package main
    
    import (
    "encoding/json"
    "fmt"
    "os"
    
    "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common"
    "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/errors"
    "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/profile"
    sms "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/sms/v20210111" // 引入sms
    )
    
    func main() {
    // 必要步骤:
    // 实例化一个认证对象,入参需要传入腾讯云账户密钥对 SecretId,SecretKey。
    // 硬编码密钥到代码中有可能随代码泄露而暴露,有安全隐患,并不推荐。
    // 为了保护密钥安全,建议将密钥设置在环境变量中或者配置文件中。
    // SecretId、SecretKey 查询: https://console.tencentcloud.com/cam/capi
    // credential := common.NewCredential("SecretId", "SecretKey")
    credential := common.NewCredential(
    os.Getenv("TENCENTCLOUD_SECRET_ID"),
    os.Getenv("TENCENTCLOUD_SECRET_KEY"),
    )
    /* 非必要步骤:
    * 实例化一个客户端配置对象,可以指定超时时间等配置 */
    cpf := profile.NewClientProfile()
    
    /* SDK默认使用POST方法。
    * 如果你一定要使用GET方法,可以在这里设置。GET方法无法处理一些较大的请求 */
    cpf.HttpProfile.ReqMethod = "POST"
    cpf.HttpProfile.ReqTimeout = 30 // 请求超时时间,单位为秒(默认60秒)
    /* 指定接入地域域名,默认就近地域接入域名为 sms.tencentcloudapi.com ,也支持指定地域域名访问,例如新加坡地域的域名为 sms.ap-singapore.tencentcloudapi.com */
    cpf.HttpProfile.Endpoint = "sms.tencentcloudapi.com"
    
    /* SDK默认用TC3-HMAC-SHA256进行签名
    * 非必要请不要修改这个字段 */
    cpf.SignMethod = "HmacSHA1"
    
    /* 实例化要请求产品(以sms为例)的client对象
    * 第二个参数是地域信息,根据您选择的国际站地域,如您选择的是新加坡国际站,则应该填入字符串ap-singapore,地域列表可参考https://www.tencentcloud.com/document/api/382/40466?lang=en#region-list */
    client, _ := sms.NewClient(credential, "ap-singapore", cpf)
    
    /* 实例化一个请求对象,根据调用的接口和实际情况,可以进一步设置请求参数
    * 你可以直接查询SDK源码确定接口有哪些属性可以设置
    * 属性可能是基本类型,也可能引用了另一个数据结构
    * 推荐使用IDE进行开发,可以方便的跳转查阅各个接口和数据结构的文档说明 */
    request := sms.NewSendStatusStatisticsRequest()
    
    /* 基本类型的设置:
    * SDK采用的是指针风格指定参数,即使对于基本类型你也需要用指针来对参数赋值。
    * SDK提供对基本类型的指针引用封装函数
    * 帮助链接:
    * 短信控制台: https://console.tencentcloud.com/smsv2
    * sms helper: https://www.tencentcloud.com/document/product/382/3773 */
    
    /* 短信应用ID: 短信SdkAppId在 [短信控制台] 添加应用后生成的实际SdkAppId,示例如2400006666 */
    request.SmsSdkAppId = common.StringPtr("2400006666")
    /* 拉取最大条数,最多100条 */
    request.Limit = common.Uint64Ptr(10)
    /* 偏移量 注:目前固定设置为0 */
    request.Offset = common.Uint64Ptr(0)
    /* 开始时间,yyyymmddhh 需要拉取的起始时间,精确到小时 */
    request.BeginTime = common.StringPtr("2019122400")
    /* 结束时间,yyyymmddhh 需要拉取的截止时间,精确到小时
    * 注:EndTime 必须大于 BeginTime */
    request.EndTime = common.StringPtr("2019122523")
    
    // 通过client对象调用想要访问的接口,需要传入请求对象
    response, err := client.SendStatusStatistics(request)
    // 处理异常
    if _, ok := err.(*errors.TencentCloudSDKError); ok {
    fmt.Printf("An API error has returned: %s", err)
    return
    }
    // 非SDK异常,直接失败。实际代码中可以加入其他的处理。
    if err != nil {
    panic(err)
    }
    b, _ := json.Marshal(response.Response)
    // 打印返回的json字符串
    fmt.Printf("%s", b)
    }

    申请短信模板

    package main
    
    import (
    "encoding/json"
    "fmt"
    "os"
    
    "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common"
    "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/errors"
    "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/profile"
    sms "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/sms/v20210111" // 引入sms
    )
    
    func main() {
    // 必要步骤:
    // 实例化一个认证对象,入参需要传入腾讯云账户密钥对 SecretId,SecretKey。
    // 硬编码密钥到代码中有可能随代码泄露而暴露,有安全隐患,并不推荐。
    // 为了保护密钥安全,建议将密钥设置在环境变量中或者配置文件中。
    // SecretId、SecretKey 查询: https://console.tencentcloud.com/cam/capi
    // credential := common.NewCredential("SecretId", "SecretKey")
    credential := common.NewCredential(
    os.Getenv("TENCENTCLOUD_SECRET_ID"),
    os.Getenv("TENCENTCLOUD_SECRET_KEY"),
    )
    /* 非必要步骤:
    * 实例化一个客户端配置对象,可以指定超时时间等配置 */
    
    cpf := profile.NewClientProfile()
    
    /* SDK默认使用POST方法。
    * 如果你一定要使用GET方法,可以在这里设置。GET方法无法处理一些较大的请求 */
    cpf.HttpProfile.ReqMethod = "POST"
    cpf.HttpProfile.ReqTimeout = 30 // 请求超时时间,单位为秒(默认60秒)
    /* 指定接入地域域名,默认就近地域接入域名为 sms.tencentcloudapi.com ,也支持指定地域域名访问,例如新加坡地域的域名为 sms.ap-singapore.tencentcloudapi.com */
    cpf.HttpProfile.Endpoint = "sms.tencentcloudapi.com"
    
    /* SDK 默认用 TC3-HMAC-SHA256 进行签名,非必要请不要修改该字段 */
    cpf.SignMethod = "HmacSHA1"
    
    /* 实例化 SMS 的 client 对象
    * 第二个参数是地域信息,根据您选择的国际站地域,如您选择的是新加坡国际站,则应该填入字符串ap-singapore,地域列表可参考https://www.tencentcloud.com/document/api/382/40466?lang=en#region-list */
    client, _ := sms.NewClient(credential, "ap-singapore", cpf)
    
    /* 实例化一个请求对象,根据调用的接口和实际情况,可以进一步设置请求参数
    * 您可以直接查询 SDK 源码确定接口有哪些属性可以设置
    * 属性可能是基本类型,也可能引用了另一个数据结构
    * 推荐使用 IDE 进行开发,可以方便地跳转查阅各个接口和数据结构的文档说明 */
    request := sms.NewAddSmsTemplateRequest()
    /* 基本类型的设置:
    * SDK 采用的是指针风格指定参数,即使对于基本类型也需要用指针来对参数赋值。
    * SDK 提供对基本类型的指针引用封装函数
    * 帮助链接:
    * 短信控制台: https://console.tencentcloud.com/smsv2
    * sms helper: https://www.tencentcloud.com/document/product/382/3773
    */
    /* 模板名称 */
    request.TemplateName = common.StringPtr("腾讯云")
    /* 模板内容 */
    request.TemplateContent = common.StringPtr("{1}为您的登录验证码,请于{2}分钟内填写,如非本人操作,请忽略本短信。")
    /* 短信类型,1表示营销短信,2表示通知短信,3表示验证码短信 */
    request.SmsType = common.Uint64Ptr(3)
    /* 是否国际/港澳台短信:
    0:表示中国大陆地区短信
    1:表示国际/港澳台短信 */
    request.International = common.Uint64Ptr(0)
    /* 模板备注:例如申请原因,使用场景等 */
    request.Remark = common.StringPtr("xxx")
    // 通过 client 对象调用想要访问的接口,需要传入请求对象
    response, err := client.AddSmsTemplate(request)
    // 处理异常
    if _, ok := err.(*errors.TencentCloudSDKError); ok {
    fmt.Printf("An API error has returned: %s", err)
    return
    }
    // 非 SDK 异常,直接失败。实际代码中可以加入其他的处理
    if err != nil {
    panic(err)
    }
    b, _ := json.Marshal(response.Response)
    // 打印返回的 JSON 字符串
    fmt.Printf("%s", b)
    }

    常见问题

    
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持