Présentation des nouveaux SDK clients de Vonage pour Android et iOS

Le Client SDK de Vonage a un nouveau nom de paquet ! Ce nouveau nom s'accompagne d'une nouvelle version majeure avec un grand nombre de nouvelles fonctionnalités et de corrections. Sous le capot, le SDK utilise maintenant Kotlin Multiplatform pour partager le code de la fonctionnalité de base entre les SDK natifs Android et iOS.

Voyons maintenant comment vous pouvez commencer à utiliser le SDK.

Ajouter le SDK

Comme mentionné, le SDK a maintenant un nouveau nom. Pour ajouter le SDK à votre application, vous devez procéder comme suit :

Android

Ajoutez la dépendance au fichier build.gradle de votre application :

implementation 'com.vonage:client-sdk-voice'

iOS

Ajoutez la dépendance à votre application Podfile:

pod 'VonageClientSDKVoice'

Concepts clés

Lorsque vous travaillez avec le SDK, vous devez vous familiariser avec certains concepts.

Session

Une session est un flux de communication en direct entre le SDK et les serveurs Vonage. Vous pouvez en apprendre davantage sur la façon de créer une session plus loin dans le blog.

Invitation

Une invitation est envoyée au SDK lorsque l'utilisateur actuel a été invité à se joindre à un appel. La fonction d'écoute/déléguée d'invitation contient les informations nécessaires sur un appel. Les invitations peuvent être acceptées ou rejetées.

Appeler

Lorsque vous acceptez une invitation, vous obtenez un identifiant d'appel. Cet identifiant vous permet d'apporter des modifications à l'appel vocal à l'aide des fonctions disponibles. Par exemple, raccrocher l'appel, mettre l'appel en sourdine ou utiliser la synthèse vocale, entre autres.

Jambes

Un segment est une connexion entre un utilisateur et un appel. Un identifiant est attribué à chaque segment. Un appel est composé de plusieurs segments. Ainsi, dans le cas de deux utilisateurs du SDK en communication, la connexion entre l'utilisateur A et Vonage serait le segment 1, et la connexion entre l'utilisateur B et Vonage serait le segment 2. L'appel est un lien entre les segments 1 et 2.

Création d'une session

Maintenant que vous avez assimilé les concepts clés, voyons comment utiliser le SDK. Avant de passer un appel, vous devez créer une session. Vous pouvez créer une session à l'aide de la fonction createSession à l'aide de la fonction

Android

val config = ClientConfig(ConfigRegion.US) 
val client = VoiceClient(this.application.applicationContext)
client.setConfig(config)

client.createSession("JWT") { err, sessionID ->
    if err == null {
    // Connected!
    }
}

iOS

let config = VGClientConfig(region: .US) 
let client = VGVoiceClient()
client.setConfig(config)

client.createSession("JWT") { error, sessionID in
    if error == nil {
    // Connected!
    }
}

Cette fonction prend un JWT pour identifier l'utilisateur auquel la session appartient. Consultez le Guide JWT pour plus d'informations sur la création de JWT à utiliser avec le Client SDK.

Passer un appel

Une fois que vous avez créé une session avec succès, vous pouvez maintenant passer un appel à l'aide de la fonction serverCall à l'aide de la fonction

Android

client.serverCall(mapOf("to" to "CALLEE")) { err, callID ->
    if err == null {
    // Connected to the call!
    }
}

iOS

client.serverCall(["to": "CALLEE"]) { error, callID in
    if error == nil {
    // Connected to the call!
    }
}

serverCall envoie une requête HTTP (via les serveurs de Vonage) à l'URL de réponse spécifiée dans votre application Vonage. Votre URL de réponse doit renvoyer un objet de contrôle d'appel indiquant à Vonage comment traiter l'appel.

Recevoir un appel

Voyons ce qu'il en est de l'autre côté lorsque vous recevez un appel :

Android

Sur Android, vous pouvez définir l'écouteur d'invitation à l'appel qui sera exécuté lorsque le SDK recevra une invitation :

client.setCallInviteListener { callId, from, channelType ->
    client.answer(it) { err ->
        if err == null {
        // Connected to the call!
        }
    }
}

iOS

Sur iOS, assurez-vous de définir le délégué de VGVoiceClientà l'aide de client.delegate = self d'abord. Lorsque le SDK reçoit une invitation, la fonction didReceiveInviteForCall de la fonction VGVoiceClientDelegate sera appelée :

func voiceClient(_ client: VGVoiceClient, didReceiveInviteForCall callId: String, from caller: String, withChannelType type: String) {
    client.answer(callId) { error in
        if error == nil {
        // Connected to the call!
        }
    }
}

Notifications push

Le nouveau Vonage Client SDK a fait des notifications push le moyen par défaut de recevoir les appels entrants, afin de garantir que tous les appels sont reçus par les appareils, que votre application soit au premier plan ou non. Pour le comportement ci-dessus, vous devrez activer les invitations WebSocket dans la configuration de votre client :

config.enableWebsocketInvites = true

Pour des informations plus approfondies sur la façon de configurer les notifications push pour le Client SDK de Vonage, veuillez vous référer aux nouveaux guides de notification push pour Android et iOS.

Quelle est la prochaine étape ?

Apprenez-en plus sur le Client SDK de Vonage sur developer.vonage.comoù vous pouvez essayer le tutoriel étape par étape sur la façon de passer des appels sortants.