Skip to main content
Un canal community est le chat de l’une des expériences Chat d’un compte. Un canal support est une conversation entre un compte et un client. Utilisez l’API Channels pour créer et lister des canaux, et pour en récupérer un par son propre ID ou par l’ID de son expérience Chat. Vous pouvez également accepter ou refuser des demandes de messages privés, marquer un canal comme lu, et résoudre ou rouvrir des conversations de support.

Endpoints

Attributs

string
requis
ID public existant du canal, conservé entre les clients REST et chat.
string | null
requis
string
requis
Date de création sous forme d’horodatage ISO 8601.
string | null
requis
Date à laquelle le canal a été supprimé ou retiré de votre liste de canaux, sous forme d’horodatage ISO 8601. Null pour un canal actif.
string | null
requis
object | null
requis
L’icône du canal. Les canaux de communauté affichent le logo de l’expérience, ou à défaut l’icône de l’app. Les canaux de support affichent le logo du compte. Les canaux privés de groupe affichent leur propre icône. Null pour les canaux privés individuels ou lorsqu’aucune image n’est définie.

Propriétés

string
requis
L’ID du fichier, préfixé par file_.
string | null
requis
Placeholder BlurHash pour une image ou 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 importations multipart.
string | null
L’ID de l’importation multipart, à renvoyer à complete. Présent uniquement lors de la création, et uniquement pour les importations multipart.
object[] | null
L’URL présignée de chaque partie. Présent uniquement lors de la création, et uniquement pour les importations multipart.

Propriétés

integer
requis
L’index (à partir de 1) de cette partie au sein de l’importation multipart.
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 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 l’importation n’est pas terminée.
object
En-têtes à envoyer avec le PUT d’importation. Présent uniquement lors de la création.
string
requis
L’étape où se trouve le fichier dans son cycle de vie d’importation.Options disponibles : pending, processing, ready, failed
string | null
URL présignée vers laquelle envoyer (PUT) les octets du fichier. Présent uniquement lors de la création, et uniquement pour les importations 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 l’importation n’est pas terminée. 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
requis
Options disponibles : private, community, support
string | null
requis
Date de la dernière activité de message enregistrée dans le canal, sous forme d’horodatage ISO 8601. Null lorsqu’aucune activité de message n’est enregistrée.
string | null
requis
object | null
requis

Propriétés

string | null
requis
ID de l’adhésion enregistrée, ou null pour les utilisateurs dont l’accès est dérivé.
string
requis
string | null
requis
Date de création de l’adhésion enregistrée au canal, sous forme d’horodatage ISO 8601. Null pour les utilisateurs dont l’accès n’a pas d’adhésion enregistrée.
string | null
requis
Votre état de boîte de réception pour un canal privé. null pour les autres utilisateurs et les autres types de canaux.Options disponibles : requested, accepted, hidden
string | null
requis
Position de lecture du participant autorisé. Les positions dans la communauté ne sont visibles que par l’utilisateur lui-même.
string | null
requis
Options disponibles : all, mentions, none
integer | null
requis
boolean | null
requis
Votre état de lecture pour le canal. null pour les autres utilisateurs.
string | null
requis
Date de dernière modification de l’adhésion enregistrée au canal, sous forme d’horodatage ISO 8601. Null pour les utilisateurs dont l’accès n’a pas d’adhésion enregistrée.
object
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ésente 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.
string
requis
ID de l’utilisateur
object | null
requis

Propriétés

boolean
requis
Empêche les membres de publier des médias.
boolean
requis
Empêche les membres de publier des liens.
string[] | null
requis
Mots bloqués dans le canal. null lorsque vous ne pouvez pas consulter ce paramètre ; une liste vide signifie qu’aucun mot n’est bloqué.
integer | null
requis
Nombre de secondes qu’un membre doit attendre entre deux messages. 0 ou null désactive le délai.
string
requis
Qui peut publier des messages.Options disponibles : everyone, admins
string
requis
Qui peut réagir aux messages.Options disponibles : everyone, no_one
string | null
requis
boolean
requis
Indique si les notifications de l’app sont activées. Les webhooks se déclenchent dans tous les cas.
object | null
requis

Propriétés

boolean
requis
string
requis
string | null
requis
Options disponibles : customer, support
string | null
requis
Date à laquelle la conversation de support a été résolue, sous forme d’horodatage ISO 8601. Null tant qu’elle n’est pas résolue.
string
requis
Options disponibles : unresolved, resolved
string
requis
Date de dernière modification du canal sous forme d’horodatage ISO 8601.
Channel