Visão geral

Neste guia, você aprenderá como adicionar o Client SDK ao seu aplicativo Android.

Pré-requisitos

O Client SDK requer um nível mínimo de API do Android 23.

Para adicionar o Client SDK ao seu projeto

Abra seu projeto do Android

Abra o código-fonte do seu projeto Android no seu IDE.

Adicionar dependências

O Vonage Client SDK para Android é distribuído em três SDKs distintos. com.vonage.client-sdk-voice para a funcionalidade de In-App Voice no aplicativo, com.vonage.client-sdk-chat para a funcionalidade de In-App Messaging, e combinadas como com.vonage.client-sdk. com.vonage.client-sdk-chat não inclui a dependência do WebRTC, por isso é uma biblioteca menor. Você deve usar apenas um SDK por vez em seu aplicativo.

  • In-App Voice e In-App Messaging — instale com.vonage.client-sdk apenas.

  • In-App Voice - instalar com.vonage.client-sdk-voice apenas.

  • In-App Messaging - instalar com.vonage.client-sdk-chat apenas.

Aviso sobre descontinuação de produto
A partir de 30 de abril de 2026, o In-App Messaging da Vonage não estará mais disponível. O acesso para novos usuários será encerrado, e o serviço será descontinuado para todos os usuários atuais.
Caso tenha alguma dúvida sobre a descontinuação deste produto, entre em contato com seu gerente de contas ou com nossa equipe de suporte.

NOTA: Existem duas linguagens utilizadas para definir os scripts de compilação do Gradle — Groovy (build.gradle arquivo) e o script Gradle do Kotlin (build.gradle.kts (arquivo). Um projeto Kotlin-Android ainda pode usar Groovy como linguagem para os scripts de compilação. Verifique a extensão do arquivo para determinar a linguagem dos arquivos de scripts de compilação.

Agora adicione o Client SDK ao seu projeto. Adicione a seguinte dependência no nível do aplicativo build.gradle arquivo (normalmente app/build.gradle):

dependencies {
    implementation 'com.vonage:client-sdk:1.6.0'
}

Talvez seja necessário aumentar a alocação de memória para a JVM editando o arquivo org.gradle.jvmargs propriedade na sua gradle.properties arquivo. Recomendamos que esse valor seja definido para, no mínimo, 4 GB:

org.gradle.jvmargs=-Xmx4096m -Dfile.encoding=UTF-8

Conjunto Java 1.8

Defina o Java 1.8 no nível do seu aplicativo build.gradle ou build.gradle.kts arquivo (normalmente app/build.gradle ou app/build.gradle.kts):

android {
   
   // ...

   compileOptions {
       sourceCompatibility JavaVersion.VERSION_1_8
       targetCompatibility JavaVersion.VERSION_1_8
   }

   // Only for Kotlin projects
   kotlinOptions {
       jvmTarget = JavaVersion.VERSION_1_8.toString()
   }
}

Adicionar permissões

Para usar os recursos de In-App Voice, conceda permissões de áudio seguindo este procedimento:

  1. Adicione as permissões necessárias ao AndroidManifest.xml arquivo:
<manifest ...>
	<uses-permission android:name="android.permission.INTERNET" />
	<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
	<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
	<uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />
	<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
	<uses-permission android:name="android.permission.RECORD_AUDIO" />
	<uses-permission android:name="android.permission.READ_PHONE_STATE"/>
</manifest>

Permissões em tempo de execução

  • Para dispositivos que rodam o Android versão 6.0 Marshmallow (nível de API 23) ou superior, você deve solicitar o RECORD_AUDIO permissão em tempo de execução:
// this is the current activity
val callsPermissions = arrayOf(Manifest.permission.RECORD_AUDIO)
ActivityCompat.requestPermissions(this, callsPermissions, 123)
  • Para dispositivos que rodam o Android versão 12 (nível de API 31) ou superior, você também deve solicitar o READ_PHONE_STATE permissão em tempo de execução:
// this is the current activity
val callsPermissions = arrayOf(Manifest.permission.RECORD_AUDIO, Manifest.permission.READ_PHONE_STATE)
ActivityCompat.requestPermissions(this, callsPermissions, 123)

Saiba mais sobre como solicitar permissões em tempo de execução no Android aqui.

Regras do ProGuard

Opcionalmente, se você estiver usando o ProGuard, será necessário configurar a ferramenta para ignorar o Vonage Client SDK. Não é recomendável compactar e/ou ofuscar o Vonage Client SDK, pois isso pode causar conflitos com outras bibliotecas. A configuração recomendada do ProGuard é:

-keep class org.webrtc.**  { *; }
-keep class org.vonage.**  { *; }
-keep class com.vonage.**  { *; }

A configuração acima faz com que o código-fonte do Vonage Client SDK seja mantido como está, ao mesmo tempo em que permite que o restante do aplicativo seja compactado. O compilador realiza automaticamente um conjunto de otimizações por padrão, mas é possível habilitar otimizações adicionais, o que pode exigir a inclusão de regras adicionais do ProGuard para evitar problemas em tempo de execução. Você pode fazer isso adicionando o seguinte ao arquivo de propriedades Gradle do projeto:

android.enableR8.fullMode=true

Para obter mais informações sobre como otimizar seu aplicativo para Android, consulte o site oficial Documentação do Android.

Como usar o Client SDK em seu aplicativo

Agora que você instalou o Client SDK e solicitou as permissões de áudio, já pode começar a usá-lo.

Criar uma sessão

As sessões são um fluxo de comunicação em tempo real entre o Client SDK do cliente e os servidores da Vonage. Crie uma VoiceClient objeto e, em seguida, criar uma sessão com um usuário JWT token.

var client = VoiceClient(this.application.applicationContext)

client.createSession("JWT_TOKEN") { error, sessionId ->
    ...     
}

Se a criação da sessão for bem-sucedida, você receberá um ID de sessão.

Status da sessão

Caso ocorram erros na sessão após ela ter sido criada com sucesso, você receberá essas informações na SessionErrorListener no VoiceClient objeto.

client.setSessionErrorListener { reason ->
    //Reason for error
}

Conclusão

Você adicionou o Client SDK ao seu aplicativo Android e criou uma sessão. Agora você pode usar o VoiceClient cliente no seu aplicativo e utilize as funcionalidades do Client SDK.

Veja também