Skip to main content
Een community-kanaal is de chat in een van de Chat-experiences van een account. Een support-kanaal is een gesprek tussen een account en één klant. Gebruik de Channels API om kanalen aan te maken en weer te geven, en om er één op te halen via het eigen ID of het ID van de bijbehorende Chat-experience. Je kunt ook verzoeken om directe berichten accepteren of weigeren, een kanaal als gelezen markeren, en supportgesprekken afhandelen of heropenen.

Endpoints

Attributen

string
vereist
Bestaand openbaar kanaal-ID, behouden in REST- en chatclients.
string | null
vereist
string
vereist
Aanmaaktijd als ISO 8601-tijdstempel.
string | null
vereist
Wanneer het kanaal is verwijderd of uit je kanalenlijst is gehaald, als ISO 8601-tijdstempel. Null voor een actief kanaal.
string | null
vereist
object | null
vereist
Het kanaalpictogram. Communitykanalen tonen het logo van de experience, met het app-pictogram als terugvaloptie. Supportkanalen tonen het logo van het account. Privé-groepskanalen tonen hun eigen pictogram. Null voor een-op-een-privékanalen of wanneer er geen afbeelding is ingesteld.

Eigenschappen

string
vereist
Het ID van het bestand, met prefix file_.
string | null
vereist
BlurHash-placeholder voor een afbeelding of video. Null wanneer niet beschikbaar of verwijderd door moderatie.
string | null
vereist
Het MIME-type van het originele bestand, bijvoorbeeld application/pdf. Blijft behouden wanneer moderatie het bestand verwijdert.
string
vereist
Wanneer het bestand is aangemaakt, als ISO 8601-tijdstempel.
number | null
vereist
Duur van audio of video in seconden. Null wanneer niet beschikbaar of verwijderd door moderatie.
string | null
vereist
De oorspronkelijke bestandsnaam, inclusief extensie.
integer | null
vereist
Hoogte van afbeelding of video in pixels. Null wanneer niet beschikbaar of verwijderd door moderatie.
integer | null
De grootte in bytes die elk deel (behalve het laatste) moet hebben. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.
string | null
Het ID van de multipart-upload, terug te geven aan complete. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.
object[] | null
De vooraf ondertekende URL voor elk deel. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.

Eigenschappen

integer
vereist
De op 1 gebaseerde index van dit deel binnen de multipart-upload.
string
vereist
De vooraf ondertekende URL waarnaar de bytes van dit deel met PUT worden verzonden.
string
vereist
Het type van dit object, altijd file.
boolean
vereist
Of moderatie het bestand heeft verwijderd. Bij true levert url een vervangende afbeelding. filename, size en content_type beschrijven nog steeds het originele bestand.
integer | null
vereist
De bestandsgrootte in bytes. null totdat de upload is voltooid.
object
Headers om mee te sturen met de upload-PUT. Alleen aanwezig bij aanmaken.
string
vereist
Waar het bestand zich in de uploadlevenscyclus bevindt.Beschikbare opties: pending, processing, ready, failed
string | null
Vooraf ondertekende URL waarnaar de bytes van het bestand met PUT worden verzonden. Alleen aanwezig bij aanmaken, en alleen voor uploads in één deel.
string | null
vereist
Een URL om het bestand te downloaden. Openbare bestanden krijgen een permanente CDN-URL en privébestanden een ondertekende URL die verloopt. null totdat de upload is voltooid. Wanneer moderatie het bestand verwijdert, een URL van een vervangende afbeelding.
string
vereist
public-bestanden worden geleverd vanaf een niet-ondertekende CDN-URL. private-bestanden worden geleverd vanaf een ondertekende URL die verloopt.Beschikbare opties: public, private
string | null
vereist
URL van de audiogolfvorm. Null wanneer niet beschikbaar of verwijderd door moderatie.
integer | null
vereist
Breedte van afbeelding of video in pixels. Null wanneer niet beschikbaar of verwijderd door moderatie.
string
vereist
Beschikbare opties: private, community, support
string | null
vereist
Wanneer het kanaal voor het laatst berichtactiviteit heeft geregistreerd, als ISO 8601-tijdstempel. Null wanneer er geen berichtactiviteit is geregistreerd.
string | null
vereist
object | null
vereist

Eigenschappen

string | null
vereist
ID van het opgeslagen lidmaatschap, of null voor gebruikers met toegang via afgeleide rechten.
string
vereist
string | null
vereist
Wanneer het opgeslagen kanaallidmaatschap is aangemaakt, als ISO 8601-tijdstempel. Null voor gebruikers van wie de toegang geen opgeslagen lidmaatschap heeft.
string | null
vereist
Je inboxstatus voor een privékanaal. null voor andere gebruikers en andere soorten kanalen.Beschikbare opties: requested, accepted, hidden
string | null
vereist
Leespositie van een geautoriseerde deelnemer. Communityposities zijn alleen zichtbaar voor de gebruiker zelf.
string | null
vereist
Beschikbare opties: all, mentions, none
integer | null
vereist
boolean | null
vereist
Je ongelezen-status voor het kanaal. null voor andere gebruikers.
string | null
vereist
Wanneer het opgeslagen kanaallidmaatschap voor het laatst is gewijzigd, als ISO 8601-tijdstempel. Null voor gebruikers van wie de toegang geen opgeslagen lidmaatschap heeft.
object
vereist

Eigenschappen

string
vereist
Gebruikers-ID, met prefix user_.
string | null
vereist
Weergavenaam.
object
vereist
Avatar-wrapper. De url is altijd aanwezig en is een gegenereerde placeholder wanneer de gebruiker geen afbeelding heeft ingesteld.

Eigenschappen

string
vereist
URL van de avatarafbeelding. Altijd aanwezig. Het is een gegenereerde placeholder wanneer de gebruiker geen afbeelding heeft ingesteld.
string
vereist
Openbare gebruikersnaam.
string
vereist
Gebruikers-ID
object | null
vereist

Eigenschappen

boolean
vereist
Voorkom dat leden media plaatsen.
boolean
vereist
Voorkom dat leden links plaatsen.
string[] | null
vereist
Woorden die in het kanaal zijn geblokkeerd. null wanneer je deze instelling niet kunt bekijken; een lege lijst betekent dat er geen woorden zijn geblokkeerd.
integer | null
vereist
Aantal seconden dat een lid tussen berichten moet wachten. 0 of null schakelt de cooldown uit.
string
vereist
Wie berichten kan plaatsen.Beschikbare opties: everyone, admins
string
vereist
Wie op berichten kan reageren.Beschikbare opties: everyone, no_one
string | null
vereist
boolean
vereist
Of app-meldingen zijn ingeschakeld. Webhooks worden hoe dan ook verzonden.
object | null
vereist

Eigenschappen

boolean
vereist
string
vereist
string | null
vereist
Beschikbare opties: customer, support
string | null
vereist
Wanneer het supportgesprek is afgehandeld, als ISO 8601-tijdstempel. Null zolang het niet is afgehandeld.
string
vereist
Beschikbare opties: unresolved, resolved
string
vereist
Laatste wijziging van het kanaal als ISO 8601-tijdstempel.
Channel