Skip to main content
Utilisez l’API Messages pour envoyer, modifier, supprimer et épingler des messages. Listez les messages d’un canal pour lire son historique et synchroniser les modifications et suppressions. Vous pouvez également réagir avec un emoji, lister qui a réagi et voter une fois dans un sondage. Chaque message indique ses nombres de réactions et de votes et si vous avez réagi ou voté, mais pas qui d’autre a voté.

Endpoints

Attributs

string
requis
ID du message, préfixé par post_. Correspond à l’id envoyé lors de la création, lorsqu’un id a été envoyé.
object[]
requis

Propriétés

string
requis
L’ID du fichier, préfixé par file_.
string | null
requis
Aperçu BlurHash d’une image ou d’une vidéo. Null lorsqu’il n’est pas disponible ou a été supprimé par la modération.
string | null
requis
Le type MIME du fichier d’origine, par exemple application/pdf. Il est conservé lorsque la modération supprime le fichier.
string
requis
Date de création du fichier, sous forme d’horodatage ISO 8601.
number | null
requis
Durée de l’audio ou de la vidéo en secondes. Null lorsqu’elle n’est pas disponible ou a été supprimée par la modération.
string | null
requis
Le nom de fichier d’origine, extension comprise.
integer | null
requis
Hauteur de l’image ou de la vidéo en pixels. Null lorsqu’elle n’est pas disponible ou a été supprimée par la modération.
integer | null
La taille en octets que doit avoir chaque partie (sauf la dernière). Présent uniquement lors de la création, et uniquement pour les téléversements en plusieurs parties.
string | null
L’ID du téléversement en plusieurs parties, à renvoyer à complete. Présent uniquement lors de la création, et uniquement pour les téléversements en plusieurs parties.
object[] | null
L’URL présignée de chaque partie. Présente uniquement lors de la création, et uniquement pour les téléversements en plusieurs parties.

Propriétés

integer
requis
L’index (à partir de 1) de cette partie dans le téléversement en plusieurs parties.
string
requis
L’URL présignée vers laquelle envoyer (PUT) les octets de cette partie.
string
requis
Le type de cet objet, toujours file.
boolean
requis
Indique si la modération a supprimé le fichier. Lorsque la valeur est true, url sert une image de remplacement. filename, size et content_type décrivent toujours le fichier d’origine.
integer | null
requis
La taille du fichier en octets. null tant que le téléversement n’est pas terminé.
object
En-têtes à envoyer avec la requête PUT de téléversement. Présent uniquement lors de la création.
string
requis
L’étape où se trouve le fichier dans son cycle de téléversement.Options disponibles : pending, processing, ready, failed
string | null
URL présignée vers laquelle envoyer (PUT) les octets du fichier. Présente uniquement lors de la création, et uniquement pour les téléversements en une seule partie.
string | null
requis
Une URL pour télécharger le fichier. Les fichiers publics obtiennent une URL CDN permanente, et les fichiers privés une URL signée qui expire. null tant que le téléversement n’est pas terminé. Lorsque la modération supprime le fichier, une URL d’image de remplacement.
string
requis
Les fichiers public sont servis depuis une URL CDN non signée. Les fichiers private sont servis depuis une URL signée qui expire.Options disponibles : public, private
string | null
requis
URL de la forme d’onde audio. Null lorsqu’elle n’est pas disponible ou a été supprimée par la modération.
integer | null
requis
Largeur de l’image ou de la vidéo en pixels. Null lorsqu’elle n’est pas disponible ou a été supprimée par la modération.
object | null
requis

Propriétés

string
requis
ID de l’utilisateur, préfixé par user_.
string | null
requis
Nom d’affichage.
object
requis
Conteneur de l’avatar. Son url est toujours présent, et correspond à une image générée par défaut lorsque l’utilisateur n’a défini aucune photo.

Propriétés

string
requis
URL de l’image de l’avatar. Toujours présente. Il s’agit d’une image générée par défaut lorsque l’utilisateur n’a défini aucune photo.
string
requis
Nom d’utilisateur public.
boolean
requis
true si l’auteur est membre de l’équipe du compte propriétaire de ce canal communautaire. false pour les partenaires, les canaux privés et de support, et les messages supprimés.
string | null
requis
string
requis
string | null
requis
Contenu Markdown. null pour un message supprimé.
string
requis
Date de création sous forme d’horodatage ISO 8601.
object | null
requis

Propriétés

string | null
requis
Nom d’affichage du webhook, ou null pour utiliser le nom de l’utilisateur.
object | null
requis
Image de profil du webhook, ou null pour utiliser l’image de l’utilisateur.

Propriétés

string
requis
L’ID du fichier, préfixé par file_.
string | null
requis
Aperçu BlurHash d’une image ou d’une vidéo. Null lorsqu’il n’est pas disponible ou a été supprimé par la modération.
string | null
requis
Le type MIME du fichier d’origine, par exemple application/pdf. Il est conservé lorsque la modération supprime le fichier.
string
requis
Date de création du fichier, sous forme d’horodatage ISO 8601.
number | null
requis
Durée de l’audio ou de la vidéo en secondes. Null lorsqu’elle n’est pas disponible ou a été supprimée par la modération.
string | null
requis
Le nom de fichier d’origine, extension comprise.
integer | null
requis
Hauteur de l’image ou de la vidéo en pixels. Null lorsqu’elle n’est pas disponible ou a été supprimée par la modération.
integer | null
La taille en octets que doit avoir chaque partie (sauf la dernière). Présent uniquement lors de la création, et uniquement pour les téléversements en plusieurs parties.
string | null
L’ID du téléversement en plusieurs parties, à renvoyer à complete. Présent uniquement lors de la création, et uniquement pour les téléversements en plusieurs parties.
object[] | null
L’URL présignée de chaque partie. Présente uniquement lors de la création, et uniquement pour les téléversements en plusieurs parties.

Propriétés

integer
requis
L’index (à partir de 1) de cette partie dans le téléversement en plusieurs parties.
string
requis
L’URL présignée vers laquelle envoyer (PUT) les octets de cette partie.
string
requis
Le type de cet objet, toujours file.
boolean
requis
Indique si la modération a supprimé le fichier. Lorsque la valeur est true, url sert une image de remplacement. filename, size et content_type décrivent toujours le fichier d’origine.
integer | null
requis
La taille du fichier en octets. null tant que le téléversement n’est pas terminé.
object
En-têtes à envoyer avec la requête PUT de téléversement. Présent uniquement lors de la création.
string
requis
L’étape où se trouve le fichier dans son cycle de téléversement.Options disponibles : pending, processing, ready, failed
string | null
URL présignée vers laquelle envoyer (PUT) les octets du fichier. Présente uniquement lors de la création, et uniquement pour les téléversements en une seule partie.
string | null
requis
Une URL pour télécharger le fichier. Les fichiers publics obtiennent une URL CDN permanente, et les fichiers privés une URL signée qui expire. null tant que le téléversement n’est pas terminé. Lorsque la modération supprime le fichier, une URL d’image de remplacement.
string
requis
Les fichiers public sont servis depuis une URL CDN non signée. Les fichiers private sont servis depuis une URL signée qui expire.Options disponibles : public, private
string | null
requis
URL de la forme d’onde audio. Null lorsqu’elle n’est pas disponible ou a été supprimée par la modération.
integer | null
requis
Largeur de l’image ou de la vidéo en pixels. Null lorsqu’elle n’est pas disponible ou a été supprimée par la modération.
string | null
requis
Date de suppression, ou null pour un message actif.
boolean
requis
object[]
requis

Propriétés

integer | null
requis
string | null
requis
object[]
requis

Propriétés

boolean
requis
string
requis
string
requis
Pied de page affiché en bas de l’embed. Null lorsque l’embed n’a pas de pied de page.

Propriétés

object | null
requis
Petite image affichée à côté du texte du pied de page. Null lorsque le pied de page n’a pas d’icône.

Propriétés

string | null
requis
integer | null
requis
string
requis
integer | null
requis
string
requis
object | null
requis

Propriétés

string | null
requis
integer | null
requis
string
requis
integer | null
requis
object | null
requis

Propriétés

string | null
requis
integer | null
requis
string
requis
integer | null
requis
string | null
requis
Date fournie par l’auteur de l’embed, sous forme d’horodatage ISO 8601 en UTC. Null lorsqu’elle est absente ou invalide.
string | null
requis
string | null
requis
object[]
requis
GIF joints au message. Vide pour un message supprimé.

Propriétés

integer
requis
Hauteur de original_url, en pixels.
string
requis
GIF en taille réelle. HTTPS sur un hôte média Klipy.
string
requis
Version réduite pour les aperçus et espaces réservés. HTTPS sur un hôte média Klipy.
string
requis
Identifiant du GIF.
string
requis
Titre du GIF.
string
requis
URL depuis laquelle le message affiche le GIF. HTTPS sur un hôte média Klipy.
integer
requis
Largeur de original_url, en pixels.

Propriétés

string | null
requis
Description de la page, ou null tant qu’elle n’est pas disponible.
string | null
requis
URL de l’icône du site, ou null lorsqu’elle n’est pas disponible.
Informations d’aperçu supplémentaires, ou null lorsqu’elles ne sont pas disponibles.

Propriétés

string | null
requis
string
requis
string
requis
string | null
requis
URL de l’image d’aperçu, ou null lorsqu’elle n’est pas disponible.
boolean
requis
Indique si le serveur est encore en train de générer cet aperçu.
string | null
requis
Titre de la page, ou null tant qu’il n’est pas disponible.
string
requis
URL dont l’aperçu est affiché.
string[]
requis
string
requis
Options disponibles : regular, system, automated
boolean
requis
string | null
requis
Texte du message non formaté. null lorsque le texte est absent ou que le message est supprimé
object | null
requis

Propriétés

object[]
requis

Propriétés

string
requis
Identifiant de l’option dans le sondage.
string
requis
integer
requis
boolean
requis
Indique si vous avez voté pour cette option.
object[]
requis

Propriétés

string
requis
Options disponibles : like, view, emoji
boolean
requis
Indique si vous avez réagi avec cette valeur.
integer
requis
integer
requis
string | null
requis
L’emoji Unicode pour une réaction emoji. Pour les autres types de réaction, la valeur de la réaction.
object | null
Le message auquel il est répondu. Omis sauf si include_replying_to_message=true. Inclut tous les champs du message sauf replying_to_message. null lorsque ce message est supprimé ou qu’aucune cible n’existe dans le même canal.
string | null
requis
string | null
requis
ID de l’utilisateur auteur du message auquel il est répondu, préfixé par user_. null en l’absence de réponse dans ce canal, ou lorsque l’un des deux messages est supprimé.
string
requis
Date de la dernière modification du message sous forme d’horodatage ISO 8601.
integer | null
requis
Nombre de vues de l’expérience. null pour les canaux de messages privés.
ChatMessage