LiveChatMessages: insert

Ajoute un message ou un sondage à un chat en direct.

Cas d'utilisation courants

Requête

Requête HTTP

POST https://www.googleapis.com/youtube/v3/liveChat/messages

Autorisation

Cette requête nécessite une autorisation avec au moins l'un des champs d'application suivants. Pour en savoir plus sur l'authentification et l'autorisation, consultez Implémenter l'authentification OAuth 2.0.

Portée
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Paramètres

Le tableau suivant présente les paramètres compatibles avec cette requête. Tous les paramètres listés sont des paramètres de requête.

Paramètres
Paramètres obligatoires
part string
Le paramètre part a deux fonctions. Il identifie les propriétés que l'opération d'écriture définira, ainsi que les propriétés que la réponse de l'API inclura. Définissez la valeur du paramètre sur snippet.

Corps de la requête

Fournissez une ressource liveChatMessage dans le corps de la requête. Pour cette ressource, vous devez spécifier des valeurs pour ces propriétés.

  • snippet.liveChatId
  • snippet.type : choisissez l'une des options suivantes : textMessageEvent ou pollEvent
  • Si le type est textMessageEvent, ajoutez snippet.textMessageDetails.messageText.
  • Si le type est pollEvent, incluez snippet.pollDetails avec les valeurs suivantes :
    • snippet.pollDetails.metadata.options.questionText
    • Liste de snippet.pollDetails.metadata.options.optionText. Vous devez indiquer au moins deux éléments et pas plus de cinq. Les éléments sont affichés de manière séquentielle dans l'ordre dans lequel ils sont listés.

Réponse

Si la requête aboutit, cette méthode renvoie une ressource "liveChatMessage" dans le corps de la réponse.

Erreurs

Le tableau suivant identifie les messages d'erreur que l'API peut renvoyer en réponse à un appel de cette méthode. Pour en savoir plus, consultez API YouTube Live Streaming - Erreurs.

Type d'erreur Détail de l'erreur Description
forbidden (403) forbidden Vous ne disposez pas des autorisations requises pour créer le message spécifié.
forbidden (403) liveChatDisabled Le chat en direct spécifié a été désactivé par le propriétaire. Par conséquent, vous ne pouvez pas y ajouter de messages.
forbidden (403) liveChatEnded Le chat en direct spécifié n'est plus actif.
invalidValue (400) messageTextInvalid Le texte du message (snippet.textMessageDetails.messageText) n'est pas valide.
notFound (404) liveChatNotFound Le chat en direct identifié dans la requête API n'existe pas. Cette erreur se produit si le chat a été supprimé par le propriétaire.
required (400) liveChatIdRequired La ressource liveChatMessage doit inclure et spécifier une valeur pour la propriété snippet.liveChatId.
required (400) messageTextRequired La ressource liveChatMessage doit inclure et spécifier une valeur pour la propriété snippet.textMessageDetails.messageText.
required (400) typeRequired La ressource liveChatMessage doit inclure et spécifier une valeur pour la propriété snippet.type. Définissez la valeur du paramètre sur text.
required (400) preconditionCheckFailed Un sondage actif épinglé existe déjà.
rateLimitExceeded rateLimitExceeded L'utilisateur a publié trop de messages Chat sur une période donnée.

Essayer

Utilisez APIs Explorer pour appeler cette API et afficher la requête et la réponse de l'API.