# Mise en route avec le chat Amazon IVS Amazon Interactive Video Service (IVS) Chat est une fonction gérée de conversation en direct qui accompagne vos flux vidéo en direct. (IVS Chat peut également être utilisé sans flux vidéo.) Vous pouvez créer des salles de chat et activer des sessions de chat entre vos utilisateurs. Chat Amazon IVS vous permet de vous concentrer sur la création d'expériences de chat personnalisées aux côtés de vidéos en direct. Vous n'avez pas besoin de gérer l'infrastructure ni de développer et de configurer des composants de vos flux de chat. Chat Amazon IVS est évolutif, sécurisé, fiable et économique. Chat Amazon IVS est idéal pour faciliter la messagerie entre les participants d'un flux vidéo en direct avec un début et une fin. Le reste de ce document vous guide à travers les étapes de création de votre première application de chat à l'aide Chat Amazon IVS. **Exemples :** les applications de démonstration suivantes sont disponibles (trois exemples d'applications clientes et une application de serveur backend pour la création de jetons) : + [Démonstration web Chat Amazon IVS](https://github.com/aws-samples/amazon-ivs-chat-web-demo) + [Démonstration Chat Amazon IVS pour Android](https://github.com/aws-samples/amazon-ivs-chat-for-android-demo) + [Démonstration Chat Amazon IVS pour iOS](https://github.com/aws-samples/amazon-ivs-chat-for-ios-demo) + [Backend de démonstration Chat Amazon IVS](https://github.com/aws-samples/amazon-ivs-chat-web-demo/tree/main/serverless) **Important :** les salles de chat qui n'ont pas de nouvelles connexions ou mises à jour depuis 24 mois sont automatiquement supprimées. **Topics** + [Étape 1 : tâches de configuration initiale](getting-started-chat-create-account.md) + [Étape 2 : créer une salle de chat](getting-started-chat-create-room.md) + [Étape 3 : créer une salle de chat](getting-started-chat-auth.md) + [Étape 4 : envoyer et recevoir votre premier message](getting-started-chat-send-and-receive.md) + [Étape 5 : vérifiez vos limites Service Quotas (facultatif)](getting-started-chat-check-service-quota.md) # Étape 1 : tâches de configuration initiale Avant de poursuivre, vous devez : 1. Créer un compte AWS. 1. Configurer les utilisateurs root et administratifs. 1. Configurer les autorisations AWS IAM (AWS Identity and Access Management). Utiliser la politique spécifiée ci-dessous. Pour connaître la marche à suivre en détail, consultez la section [Mise en route avec le streaming à faible latence IVS](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started.html) dans le *Guide de l'utilisateur Amazon IVS*. **Important** : dans « Étape 3 : configurer les autorisations IAM », utilisez cette politique pour IVS Chat : ------ #### [ JSON ] **** ``` { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "ivschat:CreateChatToken", "ivschat:CreateLoggingConfiguration", "ivschat:CreateRoom", "ivschat:DeleteLoggingConfiguration", "ivschat:DeleteMessage", "ivschat:DeleteRoom", "ivschat:DisconnectUser", "ivschat:GetLoggingConfiguration", "ivschat:GetRoom", "ivschat:ListLoggingConfigurations", "ivschat:ListRooms", "ivschat:ListTagsForResource", "ivschat:SendEvent", "ivschat:TagResource", "ivschat:UntagResource", "ivschat:UpdateLoggingConfiguration", "ivschat:UpdateRoom" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "servicequotas:ListServiceQuotas", "servicequotas:ListServices", "servicequotas:ListAWSDefaultServiceQuotas", "servicequotas:ListRequestedServiceQuotaChangeHistoryByQuota", "servicequotas:ListTagsForResource", "cloudwatch:GetMetricData", "cloudwatch:DescribeAlarms" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "logs:CreateLogDelivery", "logs:GetLogDelivery", "logs:UpdateLogDelivery", "logs:DeleteLogDelivery", "logs:ListLogDeliveries", "logs:PutResourcePolicy", "logs:DescribeResourcePolicies", "logs:DescribeLogGroups", "s3:PutBucketPolicy", "s3:GetBucketPolicy", "iam:CreateServiceLinkedRole", "firehose:TagDeliveryStream" ], "Resource": "*" } ] } ``` ------ # Étape 2 : créer une salle de chat Une salle de chat Amazon IVS est associée à des informations de configuration (par exemple, la longueur maximale du message). Les instructions disponibles dans cette section vous montrent comment utiliser la console ou l'interface de la ligne de commande AWS pour configurer des salles de conversation (y compris une configuration facultative pour la révision des messages et/ou la journalisation des messages) et créer des salles. # Instructions de console pour créer une salle de chat IVS Ces étapes sont divisées en phases, commençant par la configuration initiale de la salle et se terminant par la création finale de la salle. Vous pouvez également configurer une salle pour que les messages soient révisés. Par exemple, vous pouvez mettre à jour le contenu ou les métadonnées des messages, refuser des messages pour les empêcher d'être envoyés ou laisser passer le message d'origine. Ceci est couvert par la rubrique [Configurer pour réviser les messages de la salle (facultatif)](#create-room-console-review-messages). Vous pouvez également, de manière facultative, configurer une salle pour que les messages soient journalisés. Par exemple, si des messages sont envoyés à une salle de chat, vous pouvez les journaliser dans un compartiment Amazon S3, Amazon CloudWatch ou Amazon Kinesis Data Firehose. Ceci est couvert par la section [Configurer pour journaliser les messages de la salle (facultatif)](#create-room-console-log-messages). ## Configuration initiale de la salle 1. Ouvrez la [console Chat Amazon IVS](https://console.aws.amazon.com/ivs/chat). (Vous pouvez également accéder à la console Amazon IVS via la [console de gestion AWS](https://console.aws.amazon.com/).) 1. Choisissez une région dans le menu déroulant de la barre de navigation **Sélectionner une région**. Votre nouvelle salle sera créée dans cette région. 1. Dans la zone **Mise en route**, en haut à droite, choisissez **Salle de chat Amazon IVS**. La fenêtre **Créer une salle** apparaît. ![\[Créer une salle de chat\]](http://docs.aws.amazon.com/fr_fr/ivs/latest/ChatUserGuide/images/Chat_Create_Room.png) 1. Sous **Installation**, spécifiez éventuellement un **Nom de salle**. Les noms des salles ne sont pas uniques, mais ils vous permettent de distinguer les salles autrement que par leur ARN (Amazon Resource Name). 1. Sous **Configuration > Configuration de la salle**, acceptez soit la **Configuration par défaut**, ou sélectionnez **Configuration personnalisée** puis configurez les paramètres de **Longueur maximale du message** et/ou **Fréquence de message maximale**. 1. Si vous souhaitez réviser les messages, continuez avec [Configurer pour réviser les messages de salle (facultatif)](#create-room-console-review-messages) ci-dessous. Sinon, sautez cette section (c.-à-d., acceptez **Gestionnaire de révision des messages > Désactivé** et passez directement à [Création finale de la salle](#create-room-console-final). ## Configurer pour revoir les messages de la salle (facultatif) 1. Sous **Gestionnaire de révision des messages**, sélectionnez **Gérer avec AWS Lambda**. La section **Gestionnaire de révision des messages** se développe pour afficher des options supplémentaires. 1. Configurer le **Résultat de secours** pour **Autoriser** ou **Refuser** le message si le gestionnaire ne renvoie pas de réponse valide, rencontre une erreur ou dépasse la période d'expiration. 1. Spécifiez votre **Fonction lambda** ou utilisez **Créer une fonction lambda** pour créer une fonction. La fonction lambda doit se trouver dans le même compte AWS et les mêmes Régions AWS que le salle de chat. Vous devez accorder au service du kit SDK Amazon Chat l'autorisation d'appeler votre ressource lambda. La politique basée sur les ressources sera automatiquement créée pour la fonction lambda que vous avez sélectionnée. Pour en savoir plus sur les autorisations, consultez [Politique basée sur les ressources pour Chat Amazon IVS](security-iam.md#security-chat-policy-examples). ## Configurer pour journaliser les messages (facultatif) 1. Sous **Journalisation des messages**, sélectionnez **Journaliser automatiquement les messages de chat**. La section **Journalisation des messages** se développe pour afficher des options supplémentaires. Vous pouvez soit ajouter une configuration de journalisation existante à cette salle, soit créer une configuration de journalisation en sélectionnant **Créer une configuration de journalisation**. 1. Si vous choisissez une configuration de journalisation existante, un menu déroulant apparaît et affiche toutes les configurations de journalisation que vous avez déjà créées. Sélectionnez-en un dans la liste et vos messages de chat seront automatiquement journalisés à cette destination. 1. Si vous choisissez **Créer une configuration de journalisation**, une fenêtre modale apparaît qui vous permet de créer et de personnaliser une configuration de journalisation. 1. Spécifiez éventuellement un **nom de configuration de journalisation**. Les noms des configurations de journalisation, comme les noms des salles, ne sont pas uniques, mais ils vous permettent de distinguer les configurations de journalisation autrement que par l'ARN de la configuration de journalisation. 1. Sous **Destination**, sélectionnez le **groupe de journaux CloudWatch**, le **flux de diffusion Kinesis Firehose** ou le **compartiment Amazon S3** pour choisir la destination de vos journaux. 1. En fonction de votre destination, sélectionnez l'option permettant de créer ou d'utiliser un **groupe de journaux CloudWatch**, un **flux de diffusion Kinesis Firehose** ou un **compartiment Amazon S3** existant. 1. Après avoir vérifié, choisissez **Créer** pour créer une configuration de journalisation avec un ARN unique. Cela associe automatiquement la nouvelle configuration de journalisation à la salle de chat. ## Création finale de la salle 1. Après avoir vérifié, choisissez **Create chat room** (Créer une salle de chat) pour créer une salle de chat avec un ARN unique. # Instructions de la CLI pour créer une salle de chat IVS Ce document explique les étapes nécessaires à la création d'une salle de Chat Amazon IVS à l'aide de l'interface de ligne de commande AWS. ## Créer une salle de conversation La création d'une salle avec l'AWS CLI est une option avancée et nécessite le téléchargement et la configuration de la CLI sur votre machine. Pour plus de détails, consultez le [‬Guide de l’utilisateur de l’Interface de ligne de commande AWS‭](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html). 1. Exécutez la commande de chat `create-room` et passez un nom facultatif : ``` aws ivschat create-room --name test-room ``` 1. Ceci renvoie une nouvelle salle de chat : ``` { "arn": "arn:aws:ivschat:us-west-2:123456789012:room/g1H2I3j4k5L6", "id": "string", "createTime": "2021-06-07T14:26:05-07:00", "maximumMessageLength": 200, "maximumMessageRatePerSecond": 10, "name": "test-room", "tags": {}, "updateTime": "2021-06-07T14:26:05-07:00" } ``` 1. Notez le champ `arn`. Vous en aurez besoin pour créer un jeton client et vous connecter à une salle de chat. ## Définir une configuration de journalisation (facultatif) Comme pour la création d'une salle de chat, la définition d'une configuration de journalisation avec l'AWS CLI est une option avancée et nécessite que vous téléchargiez et configuriez d'abord la CLI sur votre machine. Pour plus de détails, consultez le [‬Guide de l’utilisateur de l’Interface de ligne de commande AWS‭](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html). 1. Exécutez la commande de chat `create-logging-configuration` et transmettez un nom facultatif et une configuration de destination pointant vers un compartiment Amazon S3 par son nom. Ce compartiment Amazon S3 doit exister avant de créer la configuration de journalisation. (Pour plus d'informations sur la création d'un compartiment Amazon S3, consultez la [documentation Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html).) ``` aws ivschat create-logging-configuration \ --destination-configuration s3={bucketName=demo-logging-bucket} \ --name "test-logging-config" ``` 1. Cela renvoie une nouvelle configuration de journalisation : ``` { "Arn": "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ", "createTime": "2022-09-14T17:48:00.653000+00:00", "destinationConfiguration": { "s3": {"bucketName": "demo-logging-bucket"} }, "id": "ABcdef34ghIJ", "name": "test-logging-config", "state": "ACTIVE", "tags": {}, "updateTime": "2022-09-14T17:48:01.104000+00:00" } ``` 1. Notez le champ `arn`. Vous en avez besoin pour associer la configuration de journalisation à la salle de chat. 1. Si vous créez une salle de chat, exécutez la commande `create-room` et transmettez la configuration de journalisation `arn` : ``` aws ivschat create-room --name test-room \ --logging-configuration-identifiers \ "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" ``` 1. Si vous mettez à jour une salle de chat existante, exécutez la commande `update-room` et transmettez la configuration de journalisation `arn` : ``` aws ivschat update-room --identifier \ "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \ --logging-configuration-identifiers \ "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" ``` # Étape 3 : créer une salle de chat Pour qu'un participant au chat puisse se connecter à une salle et commencer à envoyer et à recevoir des messages, un jeton de chat doit être créé. Les jetons de chat sont utilisés pour authentifier et autoriser les clients de chat. Ce schéma illustre le flux de travail pour créer un jeton de chat IVS : ![\[Authentifiez et autorisez vos clients pour votre salle de chat nouvellement créée.\]](http://docs.aws.amazon.com/fr_fr/ivs/latest/ChatUserGuide/images/Chat_Getting_Started_Auth.png) Comme indiqué ci-dessus, une application client demande un jeton à votre application côté serveur, et l'application côté serveur appelle CreateChatToken à l'aide d'un kit SDK AWS ou de requêtes signées [SigV4](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html). Étant donné que les informations d'identification AWS sont utilisées pour appeler l'API, le jeton doit être généré dans une application côté serveur sécurisée, et non dans l'application côté client. Une application de serveur backend qui illustre la génération de jetons est disponible sur le [backend de démonstration Chat Amazon IVS](https://github.com/aws-samples/amazon-ivs-chat-web-demo/tree/main/serverless). *Durée de la session* fait référence à la durée pendant laquelle une session établie peut rester active avant qu'elle ne soit automatiquement fermée. En d'autres termes, la durée de la session correspond à la durée pendant laquelle le client peut rester connecté à la salle de chat avant qu'un nouveau jeton ne doive être généré et qu'une nouvelle connexion ne doive être établie. Vous pouvez en option, spécifier la durée de la session lors de la création de jetons. Chaque jeton ne peut être utilisé qu'une seule fois pour établir une connexion pour un utilisateur final. Si une connexion est fermée, un nouveau jeton doit être créé avant qu'une connexion puisse être rétablie. Le jeton lui-même est valide jusqu'à l'horodatage d'expiration du jeton inclus dans la réponse. Lorsqu'un utilisateur final souhaite se connecter à une salle de chat, le client doit demander un jeton à l'application serveur. L'application serveur crée un jeton et le transmet au client. Des jetons doivent être créés pour les utilisateurs finaux à la demande. Pour créer un jeton d'authentification de chat, suivez les instructions ci-dessous. Lorsque vous créez un jeton de chat, utilisez les champs de demande pour transmettre des données concernant l'utilisateur final du chat et ses capacités de messagerie. Pour plus de détails, consultez la section [CreateChatToken](https://docs.aws.amazon.com//ivs/latest/ChatAPIReference/API_CreateChatToken.html) dans la *Référence de l'API IVS Chat*. ## Instructions du kit SDK AWS La création d'une salle de chat avec le kit SDK AWS nécessite que vous téléchargiez et configuriez d'abord le kit SDK sur votre application. Vous trouverez ci-dessous les instructions concernant le SDK AWS utilisant JavaScript. **Important :** ce code doit être exécuté côté serveur et sa sortie doit être transmise au client. **Prérequis** : pour pouvoir utiliser l'exemple de code ci-dessous, vous devez charger le kit SDK AWS JavaScript dans votre application. Pour plus d'informations, consultez la section [Mise en route avec le kit SDK AWS pour JavaScript](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-started.html). ``` async function createChatToken(params) { const ivs = new AWS.Ivschat(); const result = await ivs.createChatToken(params).promise(); console.log("New token created", result.token); } /* Create a token with provided inputs. Values for user ID and display name are from your application and refer to the user connected to this chat session. */ const params = { "attributes": { "displayName": "DemoUser", }", "capabilities": ["SEND_MESSAGE"], "roomIdentifier": "arn:aws:ivschat:us-west-2:123456789012:room/g1H2I3j4k5L6", "userId": 11231234 }; createChatToken(params); ``` ## Instructions de la CLI La création d'un jeton de chat avec l'AWS CLI est une option avancée et nécessite que vous téléchargiez et configuriez d'abord le CLI sur votre machine. Pour plus de détails, consultez le [‬Guide de l’utilisateur de l’Interface de ligne de commande AWS‭](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html). Remarque : la génération de jetons avec l'AWS CLI est utile à des fins de test, mais pour une utilisation en production, nous vous recommandons de générer des jetons côté serveur avec le kit SDK AWS (voir les instructions ci-dessus). 1. Exécutez la commande `create-chat-token` avec l'identifiant de la salle et l'ID utilisateur du client. Incluez l'une des fonctions suivantes : `"SEND_MESSAGE"`, `"DELETE_MESSAGE"`, `"DISCONNECT_USER"`. (Vous pouvez également inclure la durée de la session (en minutes) et/ou les attributs personnalisés (métadonnées) de cette session de chat. Ces champs ne sont pas affichés ci-dessous.) ``` aws ivschat create-chat-token --room-identifier "arn:aws:ivschat:us-west-2:123456789012:room/g1H2I3j4k5L6" --user-id "11231234" --capabilities "SEND_MESSAGE" ``` 1. Ceci renvoie un jeton client : ``` { "token": "abcde12345FGHIJ67890_klmno1234PQRS567890uvwxyz1234.abcd12345EFGHI67890_jklmno123PQRS567890uvwxyz1234abcde12345FGHIJ67890_klmno1234PQRS567890uvwxyz1234abcde", "sessionExpirationTime": "2022-03-16T04:44:09+00:00", "tokenExpirationTime": "2022-03-16T03:45:09+00:00" } ``` 1. Enregistrez ce jeton. Vous en aurez besoin pour vous connecter à la salle de chat et envoyer ou recevoir des messages. Vous devrez générer un autre jeton de chat avant la fin de votre session (comme indiqué par `sessionExpirationTime`). # Étape 4 : envoyer et recevoir votre premier message Utilisez votre jeton chat pour vous connecter à une salle de chat et envoyer votre premier message. Un exemple de code JavaScript est fourni ci-dessous. Des kits SDK clients sont également disponibles : consultez les sections [Chat SDK: Android Guide](chat-sdk-android.md), [Chat SDK: iOS Guide](chat-sdk-ios.md) et [Chat SDK: JavaScript Guide](chat-sdk-js.md). **Service régional :** l'exemple de code ci-dessous fait référence à votre « région de choix prise en charge ». Chat Amazon IVS propose des points de terminaison régionaux que vous pouvez utiliser pour effectuer vos demandes. Pour l'API de messagerie Chat Amazon IVS, la syntaxe générale d'un point de terminaison régional est la suivante : + wss://edge.ivschat..amazonaws.com Par exemple, le point de terminaison de la région USA Ouest (Oregon) est wss://edge.ivschat.us-west-2.amazonaws.com Pour obtenir une liste des régions prises en charge, consultez la [page Amazon IVS](https://docs.aws.amazon.com/general/latest/gr/ivs.html) dans la *Référence générale AWS*. ``` /* 1. To connect to a chat room, you need to create a Secure-WebSocket connection using the client token you created in the previous steps. Use one of the provided endpoints in the Chat Messaging API, depending on your AWS region. */ const chatClientToken = "GENERATED_CHAT_CLIENT_TOKEN_HERE"; const socket = "wss://edge.ivschat.us-west-2.amazonaws.com"; // Replace “us-west-2” with supported region of choice. const connection = new WebSocket(socket, chatClientToken); /* 2. You can send your first message by listening to user input in the UI and sending messages to the WebSocket connection. */ const payload = { "Action": "SEND_MESSAGE", "RequestId": "OPTIONAL_ID_YOU_CAN_SPECIFY_TO_TRACK_THE_REQUEST", "Content": "text message", "Attributes": { "CustomMetadata": "test metadata" } } connection.send(JSON.stringify(payload)); /* 3. To listen to incoming chat messages from this WebSocket connection and display them in your UI, you must add some event listeners. */ connection.onmessage = (event) => { const data = JSON.parse(event.data); displayMessages({ display_name: data.Sender.Attributes.DisplayName, message: data.Content, timestamp: data.SendTime }); } function displayMessages(message) { // Modify this function to display messages in your chat UI however you like. console.log(message); } /* 4. Delete a chat message by sending the DELETE_MESSAGE action to the WebSocket connection. The connected user must have the "DELETE_MESSAGE" permission to perform this action. */ function deleteMessage(messageId) { const deletePayload = { "Action": "DELETE_MESSAGE", "Reason": "Deleted by moderator", "Id": "${messageId}" } connection.send(deletePayload); } ``` Félicitations, vous êtes prêt \$1 Vous disposez désormais d'une application de chat simple qui peut envoyer ou recevoir des messages. # Étape 5 : vérifiez vos limites Service Quotas (facultatif) Vos salles de chat évolueront avec votre flux en direct Amazon IVS, afin de permettre à tous vos utilisateurs de s'engager dans des conversations de chat. Cependant, tous les comptes Amazon IVS ont des limites de nombre de participants au chat simultanés et de taux de remise des messages. *Assurez-vous de définir des limites adéquates et augmentez-les si nécessaire, surtout si vous prévoyez un événement de streaming à large échelle*. Pour plus de détails, consultez les sections [Quotas de service (streaming à faible latence)](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/service-quotas.html), [Quotas de service (Streaming en temps réel)](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html) et [Quotas de service (Chat)](service-quotas.md).