Skip to main content
Un canal community es el chat de una de las experiencias de Chat de una cuenta. Un canal support es una conversación entre una cuenta y un cliente. Usa la API de Channels para crear y listar canales, y para recuperar uno por su propio ID o por el ID de su experiencia de Chat. También puedes aceptar o rechazar solicitudes de mensajes directos, marcar un canal como leído y resolver o reabrir conversaciones de soporte.

Endpoints

Atributos

string
requerido
ID público existente del canal, conservado entre REST y los clientes de chat.
string | null
requerido
string
requerido
Hora de creación como marca de tiempo ISO 8601.
string | null
requerido
Cuándo se eliminó el canal o se quitó de tu lista de canales, como marca de tiempo ISO 8601. Null para un canal activo.
string | null
requerido
object | null
requerido
El icono del canal. Los canales de comunidad muestran el logotipo de la experiencia y, si no hay, el icono de la app. Los canales de soporte muestran el logotipo de la cuenta. Los canales privados grupales muestran su propio icono. Null para canales privados individuales o cuando no hay imagen configurada.

Propiedades

string
requerido
El ID del archivo, con el prefijo file_.
string | null
requerido
Marcador de posición BlurHash para una imagen o un video. Null cuando no está disponible o fue eliminado por moderación.
string | null
requerido
El tipo MIME del archivo original, por ejemplo application/pdf. Se conserva cuando la moderación elimina el archivo.
string
requerido
Cuándo se creó el archivo, como marca de tiempo ISO 8601.
number | null
requerido
Duración del audio o video en segundos. Null cuando no está disponible o fue eliminado por moderación.
string | null
requerido
El nombre de archivo original, incluida su extensión.
integer | null
requerido
Altura de la imagen o el video en píxeles. Null cuando no está disponible o fue eliminado por moderación.
integer | null
El tamaño en bytes que debe tener cada parte (excepto la última). Presente solo al crear y solo para subidas multiparte.
string | null
El ID de la subida multiparte, que se devuelve a complete. Presente solo al crear y solo para subidas multiparte.
object[] | null
La URL prefirmada de cada parte. Presente solo al crear y solo para subidas multiparte.

Propiedades

integer
requerido
El índice, empezando en 1, de esta parte dentro de la subida multiparte.
string
requerido
La URL prefirmada a la que hacer PUT de los bytes de esta parte.
string
requerido
El tipo de este objeto, siempre file.
boolean
requerido
Si la moderación eliminó el archivo. Cuando es true, url sirve una imagen de reemplazo. filename, size y content_type siguen describiendo el archivo original.
integer | null
requerido
El tamaño del archivo en bytes. null hasta que termina la subida.
object
Encabezados que se deben enviar con el PUT de la subida. Presente solo al crear.
string
requerido
En qué punto de su ciclo de vida de subida se encuentra el archivo.Opciones disponibles: pending, processing, ready, failed
string | null
URL prefirmada a la que hacer PUT de los bytes del archivo. Presente solo al crear y solo para subidas de una sola parte.
string | null
requerido
Una URL para descargar el archivo. Los archivos públicos obtienen una URL de CDN permanente y los privados una URL firmada que caduca. null hasta que termina la subida. Cuando la moderación elimina el archivo, una URL de imagen de reemplazo.
string
requerido
Los archivos public se sirven desde una URL de CDN sin firmar. Los archivos private se sirven desde una URL firmada que caduca.Opciones disponibles: public, private
string | null
requerido
URL de la forma de onda del audio. Null cuando no está disponible o fue eliminada por moderación.
integer | null
requerido
Ancho de la imagen o el video en píxeles. Null cuando no está disponible o fue eliminado por moderación.
string
requerido
Opciones disponibles: private, community, support
string | null
requerido
Cuándo registró el canal actividad de mensajes por última vez, como marca de tiempo ISO 8601. Null cuando no hay actividad de mensajes registrada.
string | null
requerido
object | null
requerido

Propiedades

string | null
requerido
ID de la membresía almacenada, o null para usuarios con acceso derivado.
string
requerido
string | null
requerido
Cuándo se creó la membresía del canal almacenada, como marca de tiempo ISO 8601. Null para usuarios cuyo acceso no tiene una membresía almacenada.
string | null
requerido
Tu estado de bandeja de entrada para un canal privado. null para otros usuarios y otros tipos de canal.Opciones disponibles: requested, accepted, hidden
string | null
requerido
Posición de lectura del participante autorizado. Las posiciones en comunidades solo son visibles para el propio usuario.
string | null
requerido
Opciones disponibles: all, mentions, none
integer | null
requerido
boolean | null
requerido
Tu estado de no leídos del canal. null para otros usuarios.
string | null
requerido
Cuándo cambió por última vez la membresía del canal almacenada, como marca de tiempo ISO 8601. Null para usuarios cuyo acceso no tiene una membresía almacenada.
object
requerido

Propiedades

string
requerido
ID de usuario, con el prefijo user_.
string | null
requerido
Nombre para mostrar.
object
requerido
Contenedor del avatar. Su url siempre está presente y es un marcador de posición generado cuando el usuario no ha configurado ninguna imagen.

Propiedades

string
requerido
URL de la imagen del avatar. Siempre presente. Es un marcador de posición generado cuando el usuario no ha configurado ninguna imagen.
string
requerido
Nombre de usuario público.
string
requerido
ID de usuario
object | null
requerido

Propiedades

boolean
requerido
Impedir que los miembros publiquen contenido multimedia.
boolean
requerido
Impedir que los miembros publiquen enlaces.
string[] | null
requerido
Palabras bloqueadas en el canal. null cuando no puedes ver esta configuración; una lista vacía significa que no hay palabras bloqueadas.
integer | null
requerido
Segundos que un miembro debe esperar entre mensajes. 0 o null desactiva el tiempo de espera.
string
requerido
Quién puede publicar mensajes.Opciones disponibles: everyone, admins
string
requerido
Quién puede reaccionar a los mensajes.Opciones disponibles: everyone, no_one
string | null
requerido
boolean
requerido
Si las notificaciones de la app están activadas. Los webhooks se disparan en cualquier caso.
object | null
requerido

Propiedades

boolean
requerido
string
requerido
string | null
requerido
Opciones disponibles: customer, support
string | null
requerido
Cuándo se resolvió la conversación de soporte, como marca de tiempo ISO 8601. Null mientras no esté resuelta.
string
requerido
Opciones disponibles: unresolved, resolved
string
requerido
Último cambio del canal como marca de tiempo ISO 8601.
Channel