当前位置：主页 > 查看内容

语音消息 Java SDK - SDK 文档

发布时间：2021-10-22 00:00| 有位朋友查看

简介：SDK 3.0是云 API 3.0平台的配套工具，您可以通过 SDK 使用所有语音消息 API。新版 SDK 实现了统一化，具有各个语言版本的 SDK 使用方法相同，接口调用方式相同，错误码相同以及返回包格式相同等优点。注意：发送语音验证码只需提供验证码数字，如需自定……

SDK 3.0是云 API 3.0平台的配套工具，您可以通过 SDK 使用所有语音消息 API。新版 SDK 实现了统一化，具有各个语言版本的 SDK 使用方法相同，接口调用方式相同，错误码相同以及返回包格式相同等优点。

注意：

发送语音验证码
只需提供验证码数字，如需自定义内容，可以发送语音通知。例如，当 msg=“5678” 时，您收到的语音通知为您的语音验证码是五六七八。。

发送语音通知
数字默认按照个十百千万进行播报，可通过在数字前添加英文逗号（,）改变播报方式。例如，当 msg=您的语音验证码是5678。 时，您收到的语音通知为您的语音验证码是五千六百七十八。，当 msg=您的语音验证码是5,6,7,8。时，您收到的语音通知为您的语音验证码是五六七八。。

前提条件

已开通语音消息服务，具体操作请参见快速入门。
已准备依赖环境：JDK 7 版本及以上。
已在访问管理控制台 >【API密钥管理】页面获取 SecretID 和 SecretKey。
- SecretID 用于标识 API 调用者的身份。
- SecretKey 用于加密签名字符串和服务器端验证签名字符串的密钥，SecretKey 需妥善保管，避免泄露。
语音消息的调用地址为vms.tencentcloudapi.com。

安装 SDK

通过 Maven 安装（推荐）

Maven 是 Java 的依赖管理工具，支持您项目所需的依赖项，并将其安装到项目中。

访问 Maven 官网下载对应系统 Maven 安装包进行安装。
添加 Maven 依赖项，只需在 Maven pom.xml 添加以下依赖项即可：

注意：

版本号仅为示例，请在 Maven 仓库获取最新的版本号并替换。

<dependency>
        <groupId>com.tencentcloudapi</groupId>
        <artifactId>tencentcloud-sdk-java</artifactId>
        <version>3.1.188</version><!-- 注：这里只是示例版本号，请获取并替换为 最新的版本号 -->
</dependency>

引用方法可参考示例代码。

通过源码包安装

下载源码压缩包。
解压源码包到您项目中合适的位置。
将 vendor 目录下的 jar 包放在 Java 可找到的路径中。
引用方法可参考示例代码。

示例代码

说明：

所有示例代码仅作参考，无法直接编译和运行，需根据实际情况进行修改，您也可以根据实际需求使用 API 3.0 Explorer 自动化生成 Demo 代码。

每个接口都有一个对应的 Request 结构和一个 Response 结构。示例代码如下所示。

发送语音验证码

import com.tencentcloudapi.common.Credential;
import com.tencentcloudapi.common.exception.TencentCloudSDKException;
// 导入可选配置类
import com.tencentcloudapi.common.profile.ClientProfile;
import com.tencentcloudapi.common.profile.HttpProfile;
// 导入对应VMS模块的client
import com.tencentcloudapi.vms.v20200902.VmsClient;
// 导入要请求接口对应的request response类
import com.tencentcloudapi.vms.v20200902.models.SendCodeVoiceRequest;
import com.tencentcloudapi.vms.v20200902.models.SendCodeVoiceResponse;
/**
* Tencent Cloud Vms SendCodeVoice
* https://cloud.tencent.com/document/product/1128/51559
*
*/
public class SendCodeVoice
{
  public static void main(String[] args)
  {
      try {
          /* 必要步骤：
           * 实例化一个认证对象，入参需要传入腾讯云账户密钥对 secretId，secretKey。
           * 这里采用的是从环境变量读取的方式，需要在环境变量中先设置这两个值。
           * 您也可以直接在代码中写死密钥对，但是小心不要将代码复制、上传或者分享给他人，
           * 以免泄露密钥对危及您的财产安全。
           * CAM密匙查询: https://console.cloud.tencent.com/cam/capi*/
          Credential cred = new Credential("secretId", "secretKey");
           // 实例化一个http选项，可选，没有特殊需求可以跳过
          HttpProfile httpProfile = new HttpProfile();
          // 设置代理
          // httpProfile.setProxyHost("host");
          // httpProfile.setProxyPort(port);
          /* SDK默认使用POST方法。
           * 如果您一定要使用GET方法，可以在这里设置。GET方法无法处理一些较大的请求 */
          httpProfile.setReqMethod("POST");
          /* SDK有默认的超时时间，非必要请不要进行调整
           * 如有需要请在代码中查阅以获取最新的默认值 */
          httpProfile.setConnTimeout(60);
          /* SDK会自动指定域名。通常是不需要特地指定域名的，但是如果您访问的是金融区的服务
           * 则必须手动指定域名，例如vms的上海金融区域名： vms.ap-shanghai-fsi.tencentcloudapi.com */
          httpProfile.setEndpoint("vms.tencentcloudapi.com");
           /* 非必要步骤:
           * 实例化一个客户端配置对象，可以指定超时时间等配置 */
          ClientProfile clientProfile = new ClientProfile();
          /* SDK默认用TC3-HMAC-SHA256进行签名
           * 非必要请不要修改这个字段 */
          clientProfile.setSignMethod("TC3-HMAC-SHA256");
          clientProfile.setHttpProfile(httpProfile);
          /* 实例化要请求产品(以vms为例)的client对象
           * 第二个参数是地域信息，可以直接填写字符串ap-guangzhou，或者引用预设的常量 */
          VmsClient client = new VmsClient(cred, "ap-guangzhou", clientProfile);
          /* 实例化一个请求对象，根据调用的接口和实际情况，可以进一步设置请求参数
           * 您可以直接查询SDK源码确定接口有哪些属性可以设置
           * 属性可能是基本类型，也可能引用了另一个数据结构
           * 推荐使用IDE进行开发，可以方便的跳转查阅各个接口和数据结构的文档说明 */
          SendCodeVoiceRequest req = new SendCodeVoiceRequest();
           /* 填充请求参数,这里request对象的成员变量即对应接口的入参
           * 您可以通过官网接口文档或跳转到request对象的定义处查看请求参数的定义
           * 基本类型的设置:
           * 帮助链接：
           * 语音消息控制台：https://console.cloud.tencent.com/vms
           * vms helper：https://cloud.tencent.com/document/product/1128/37720 */
           // 验证码，仅支持填写数字，实际播报语音时，会自动在数字前补充语音文本"您的验证码是"
          String codeMessage = "1234";
          req.setCodeMessage(codeMessage);
           /* 被叫手机号码，采用 e.164 标准，格式为+[国家或地区码][用户号码]
           * 例如：+8613711112222，其中前面有一个+号，86为国家码，13711112222为手机号 */
          String calledNumber = "+8613711112222";
          req.setCalledNumber(calledNumber);
           // 在 [语音控制台] 添加应用后生成的实际SdkAppid，示例如1400006666
          String voiceSdkAppid = "1400006666";
          req.setVoiceSdkAppid(voiceSdkAppid);
           // 播放次数，可选，最多3次，默认2次
          Long playTimes = 2L;
          req.setPlayTimes(playTimes);
           // 用户的 session 内容，腾讯 server 回包中会原样返回
          String sessionContext = "xxxx";
          req.setSessionContext(sessionContext);
           /* 通过 client 对象调用 SendCodeVoice 方法发起请求。注意请求方法名与请求对象是对应的
           * 返回的 res 是一个 SendCodeVoiceResponse 类的实例，与请求对象对应 */
          SendCodeVoiceResponse res = client.SendCodeVoice(req);
           // 输出json格式的字符串回包
          System.out.println(SendCodeVoiceResponse.toJsonString(res));
           // 也可以取出单个值，您可以通过官网接口文档或跳转到response对象的定义处查看返回字段的定义
          System.out.println(res.getRequestId());
       } catch (TencentCloudSDKException e) {
          e.printStackTrace();
      }
  }
}

指定模版发送语音通知

import com.tencentcloudapi.common.Credential;
import com.tencentcloudapi.common.exception.TencentCloudSDKException;
// 导入可选配置类
import com.tencentcloudapi.common.profile.ClientProfile;
import com.tencentcloudapi.common.profile.HttpProfile;
// 导入对应VMS模块的client
import com.tencentcloudapi.vms.v20200902.VmsClient;
// 导入要请求接口对应的request response类
import com.tencentcloudapi.vms.v20200902.models.SendTtsVoiceRequest;
import com.tencentcloudapi.vms.v20200902.models.SendTtsVoiceResponse;
/**
* Tencent Cloud Vms SendTtsVoice
* https://cloud.tencent.com/document/product/1128/51558
*
*/
public class SendTtsVoice
{
  public static void main(String[] args)
  {
      try {
          /* 必要步骤：
           * 实例化一个认证对象，入参需要传入腾讯云账户密钥对secretId，secretKey。
           * 这里采用的是从环境变量读取的方式，需要在环境变量中先设置这两个值。
           * 您也可以直接在代码中写死密钥对，但是小心不要将代码复制、上传或者分享给他人，
           * 以免泄露密钥对危及您的财产安全。
           * CAM密匙查询: https://console.cloud.tencent.com/cam/capi*/
          Credential cred = new Credential("secretId", "secretKey");
           // 实例化一个http选项，可选，没有特殊需求可以跳过
          HttpProfile httpProfile = new HttpProfile();
          // 设置代理
          // httpProfile.setProxyHost("host");
          // httpProfile.setProxyPort(port);
          /* SDK默认使用POST方法。
           * 如果您一定要使用GET方法，可以在这里设置。GET方法无法处理一些较大的请求 */
          httpProfile.setReqMethod("POST");
          /* SDK有默认的超时时间，非必要请不要进行调整
           * 如有需要请在代码中查阅以获取最新的默认值 */
          httpProfile.setConnTimeout(60);
          /* SDK会自动指定域名。通常是不需要特地指定域名的，但是如果您访问的是金融区的服务
           * 则必须手动指定域名，例如vms的上海金融区域名： vms.ap-shanghai-fsi.tencentcloudapi.com */
          httpProfile.setEndpoint("vms.tencentcloudapi.com");
           /* 非必要步骤:
           * 实例化一个客户端配置对象，可以指定超时时间等配置 */
          ClientProfile clientProfile = new ClientProfile();
          /* SDK默认用TC3-HMAC-SHA256进行签名
           * 非必要请不要修改这个字段 */
          clientProfile.setSignMethod("TC3-HMAC-SHA256");
          clientProfile.setHttpProfile(httpProfile);
          /* 实例化要请求产品(以vms为例)的client对象
           * 第二个参数是地域信息，可以直接填写字符串ap-guangzhou，或者引用预设的常量 */
          VmsClient client = new VmsClient(cred, "ap-guangzhou", clientProfile);
          /* 实例化一个请求对象，根据调用的接口和实际情况，可以进一步设置请求参数
           * 您可以直接查询SDK源码确定接口有哪些属性可以设置
           * 属性可能是基本类型，也可能引用了另一个数据结构
           * 推荐使用IDE进行开发，可以方便的跳转查阅各个接口和数据结构的文档说明 */
          SendTtsVoiceRequest req = new SendTtsVoiceRequest();
           /* 填充请求参数,这里request对象的成员变量即对应接口的入参
           * 您可以通过官网接口文档或跳转到request对象的定义处查看请求参数的定义
           * 基本类型的设置:
           * 帮助链接：
           * 语音消息控制台：https://console.cloud.tencent.com/vms
           * vms helper：https://cloud.tencent.com/document/product/1128/37720 */
           // 模板 ID，必须填写在控制台审核通过的模板 ID，可登录 [语音消息控制台] 查看模板 ID
          String templateId = "4356";
          req.setTemplateId(templateId);
           // 模板参数，若模板没有参数，请提供为空数组
          String[] templateParamSet = {"7652"};
          req.setTemplateParamSet(templateParamSet);
           /* 被叫手机号码，采用 e.164 标准，格式为+[国家或地区码][用户号码]
           * 例如：+8613711112222，其中前面有一个+号，86为国家码，13711112222为手机号 */
          String calledNumber = "+8613711112222";
          req.setCalledNumber(calledNumber);
           // 在 [语音控制台] 添加应用后生成的实际SdkAppid，示例如1400006666
          String voiceSdkAppid = "1400006666";
          req.setVoiceSdkAppid(voiceSdkAppid);
           // 播放次数，可选，最多3次，默认2次
          Long playTimes = 2L;
          req.setPlayTimes(playTimes);
           // 用户的 session 内容，腾讯 server 回包中会原样返回
          String sessionContext = "xxxx";
          req.setSessionContext(sessionContext);
           /* 通过 client 对象调用 SendTtsVoice 方法发起请求。注意请求方法名与请求对象是对应的
           * 返回的 res 是一个 SendTtsVoiceResponse 类的实例，与请求对象对应 */
          SendTtsVoiceResponse res = client.SendTtsVoice(req);
           // 输出json格式的字符串回包
          System.out.println(SendTtsVoiceResponse.toJsonString(res));
           // 也可以取出单个值，您可以通过官网接口文档或跳转到response对象的定义处查看返回字段的定义
          System.out.println(res.getRequestId());
       } catch (TencentCloudSDKException e) {
          e.printStackTrace();
      }
  }
}

本站部分内容转载于网络，版权归原作者所有，转载之目的在于传播更多优秀技术内容，如有侵权请联系QQ/微信：153890879删除，谢谢！

上一篇：多行数据操作 - 表格存储 Tablestore 下一篇：没有了

语音消息 Java SDK - SDK 文档

前提条件

相关资料

安装 SDK

通过 Maven 安装（推荐）

通过源码包安装

示例代码

发送语音验证码

指定模版发送语音通知

推荐图文

世界主流Unix服务器厂商介绍

使用Packer创建自定义镜像 - 云服务器 ECS

dubbo-go v3 版本 go module 踩坑记

开发者学堂课程干货总结——Dubbo 分布式服务治理实

【腾讯云监控】AIOps中的告警关联收敛方案

在多线程环境中，Synchronized到底该不该用？

随机推荐

混合云迁移策略的五个关键因素

基础版/企业版/旗舰版_企业主机安全 HSS_

流媒体服务器租用找TOP云科技

语音消息统计分析 - 控制台指南

用 JavaScript 操作 Cookie

SDK示例 - 文件存储 HDFS

SFS容量型资源包可以叠加购买吗？_弹性文

服务器虚拟化面临的五大挑战

数据中心时代主机托管的未来发展

服务器租用托管的网络环境很重要

关于我们