vonage java sdk

Java的Vonage Server SDK

此Java SDK允许您在任何基于JVM的应用程序中使用Vonage API。您需要创建一个Vonage帐户。

• 支持的API
• 其他SDK
• 安装
• 用法
• 配置
• 常问问题
• 贡献！

支持的API

• 帐户
• 应用
• 对话
• 转换
• 消息
• 数字洞察力
• 数字管理
• 数字验证
• 纂
• 模拟交换
• 短信
• 子帐户
• 核实
• 视频
• 嗓音

其他SDK

我们还提供其他语言的服务器SDK：

• 科特林
• 。网
• php
• Python
• 红宝石
• nodejs

我们还为iOS，Android和JavaScript提供客户端SDK。查看我们在Vonage开发人员门户网站上的所有SDK和集成。

安装

发布发行给Maven Central。您的构建系统的说明可以在“摘要”部分中找到。我们强烈建议您使用支持依赖性管理的工具，例如Maven，Gradle或Ivy。

每个版本的发行说明都可以在ChangElog中找到。

自己构建

或者，您可以克隆回购并自己构建JAR文件：

git clone [email protected]:vonage/vonage-java-sdk.git
mvn install -P uberjar

uberjar配置文件将创建一个JAR文件，其中包含的SDK所需的所有依赖项，可以在target目录中找到。 install目标将使您的本地Maven存储库中的SDK及其依赖关系可用（通常位于您的~/.m2目录下），然后可以从机器上本地的其他项目中使用。要在Gradle项目中使用它，您需要包括依赖关系坐标，然后将mavenLocal()添加到build.gradle文件中的repositories库中。

用法

• 为了帮助了解我们的API，请查看我们出色的开发人员门户。
• 检查Javadoc以获取完整的参考文档。
• 我们的Vonage/Vonage-Java-Code-Snippets存储库中也有许多有用的代码示例。
• 有关视频API使用说明，请参阅开发人员门户网站的指南。

配置

典型的实例化

对于默认配置，您只需要使用API​​密钥和秘密，私有密钥和应用程序ID或两者指定Vonage帐户凭据。为了最大程度地兼容所有API，建议您指定这两种身份验证方法，例如：

 VonageClient client = VonageClient . builder ()
        . applicationId ( APPLICATION_ID )
        . privateKeyPath ( PRIVATE_KEY_PATH )
        . apiKey ( API_KEY )
        . apiSecret ( API_SECRET )
        . build ();

自定义基本URI

默认情况下，客户端将使用https://api.nexmo.com，https://rest.nexmo.com，https://api-eu.vonage.com和https://video.api.api.vonage.com作为各种端点的基础uris。要自定义这些，您可以使用HttpConfig对象实例化VonageClient 。

已经创建了HttpConfig.Builder来协助构建此对象。用法如下：

 HttpConfig httpConfig = HttpConfig . builder ()
        . apiBaseUri ( "https://api.example.com" )
        . restBaseUri ( "https://rest.example.com" )
        . apiEuBaseUri ( "https://api-eu.example.com" )
        . videoBaseUri ( "https://video.example.com" )
        . build ();

VonageClient client = VonageClient . builder ()
        . apiKey ( API_KEY ). apiSecret ( API_SECRET )
        . httpConfig ( httpConfig )
        . build ();

如果您不指定属性，则将采用默认值为的任何内容。您还可以使用一种方法设置所有三个方法：

 HttpConfig httpConfig = HttpConfig . builder (). baseUri ( "http://example.com" ). build ();

VonageClient client = VonageClient . builder ()
        . apiKey ( API_KEY ). apiSecret ( API_SECRET )
        . httpConfig ( httpConfig )
        . build ();

自定义超时

默认情况下，SDK的请求有1分钟的超时。您可以使用HttpConfig更改它为更长或更短。以下示例将其设置为12秒：

 VonageClient client = VonageClient . builder ()
        . applicationId ( APPLICATION_ID )
        . privateKeyPath ( PRIVATE_KEY_PATH )
        . httpConfig ( HttpConfig . builder (). timeoutMillis ( 12_000 ). build ())
        . build ();

常见问题

问： com.vonage:client ？

答：避免与我们的各种客户端SDK混淆，该服务器端SDK已从com.vonage:client坐标转移到com.vonage:server-sdk 。旧的Artifactid（ com.vonage:client ）将无法获得进一步的更新。所有用户都应迁移到新的Artifactid。请注意，SDK在功能上是相同的，它只是Maven Central上的名称空间更改。

问：您对线程安全的政策是什么？

答： SDK的当前体系结构意味着一次只能使用客户端。如果您想在多线程环境中使用SDK，请为每个线程创建一个单独的VonageClient实例。

问：此SDK是否支持异步请求 /响应处理？

答：目前没有，但在路线图上。

问：我如何从图表盒迁移到Vonage？

答：请参阅《 Opentok迁移指南》。

贡献！

我们为这个图书馆做出了贡献！

如果您打算添加任何新功能，最好先与我们交谈。否则，始终对图书馆的错误报告，错误修复和反馈表示赞赏。

接触