Skip to main content
Gebruik de Messages API om berichten te versturen, te bewerken, te verwijderen en vast te pinnen. Vraag de berichten van een channel op om de geschiedenis te lezen en bewerkingen en verwijderingen te synchroniseren. Je kunt ook met een emoji reageren, opvragen wie heeft gereageerd en eenmaal stemmen op een poll. Elk bericht toont het aantal reacties en stemmen en of jij hebt gereageerd of gestemd, maar niet wie er nog meer heeft gestemd.

Endpoints

Attributen

string
vereist
Message-ID, met prefix post_. Komt overeen met de id die bij het aanmaken is meegestuurd, als die is meegestuurd.
object[]
vereist

Eigenschappen

string
vereist
De 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 oorspronkelijke 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 de 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
De ID van de multipart-upload, die je teruggeeft aan complete. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.
object[] | null
De presigned 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 presigned URL waarnaar je de bytes van dit deel met PUT verstuurt.
string
vereist
Het type van dit object, altijd file.
boolean
vereist
Of moderatie het bestand heeft verwijderd. Wanneer true, levert url een vervangende afbeelding. filename, size en content_type beschrijven nog steeds het oorspronkelijke bestand.
integer | null
vereist
De bestandsgrootte in bytes. null totdat de upload is voltooid.
object
Headers die je met de upload-PUT meestuurt. Alleen aanwezig bij aanmaken.
string
vereist
Waar het bestand zich in de uploadlevenscyclus bevindt.Beschikbare opties: pending, processing, ready, failed
string | null
Presigned URL waarnaar je de bytes van het bestand met PUT verstuurt. Alleen aanwezig bij aanmaken, en alleen voor uploads uit één deel.
string | null
vereist
Een URL om het bestand te downloaden. Openbare bestanden krijgen een permanente CDN-URL, en privébestanden krijgen 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 via een niet-ondertekende CDN-URL. private-bestanden worden geleverd via 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 de afbeelding of video in pixels. Null wanneer niet beschikbaar of verwijderd door moderatie.
object | null
vereist

Eigenschappen

string
vereist
User-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 foto heeft ingesteld.

Eigenschappen

string
vereist
URL van de avatarafbeelding. Altijd aanwezig. Het is een gegenereerde placeholder wanneer de gebruiker geen foto heeft ingesteld.
string
vereist
Openbare gebruikersnaam.
boolean
vereist
true als de auteur een teamlid is van het account dat eigenaar is van dit community-channel. false voor partners, privé- en supportchannels, en verwijderde berichten.
string | null
vereist
string
vereist
string | null
vereist
Markdown-inhoud. null voor een verwijderd bericht.
string
vereist
Aanmaaktijdstip als ISO 8601-tijdstempel.
object | null
vereist

Eigenschappen

string | null
vereist
Weergavenaam van de webhook, of null om de naam van de gebruiker te gebruiken.
object | null
vereist
Profielafbeelding van de webhook, of null om de afbeelding van de gebruiker te gebruiken.

Eigenschappen

string
vereist
De 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 oorspronkelijke 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 de 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
De ID van de multipart-upload, die je teruggeeft aan complete. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.
object[] | null
De presigned 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 presigned URL waarnaar je de bytes van dit deel met PUT verstuurt.
string
vereist
Het type van dit object, altijd file.
boolean
vereist
Of moderatie het bestand heeft verwijderd. Wanneer true, levert url een vervangende afbeelding. filename, size en content_type beschrijven nog steeds het oorspronkelijke bestand.
integer | null
vereist
De bestandsgrootte in bytes. null totdat de upload is voltooid.
object
Headers die je met de upload-PUT meestuurt. Alleen aanwezig bij aanmaken.
string
vereist
Waar het bestand zich in de uploadlevenscyclus bevindt.Beschikbare opties: pending, processing, ready, failed
string | null
Presigned URL waarnaar je de bytes van het bestand met PUT verstuurt. Alleen aanwezig bij aanmaken, en alleen voor uploads uit één deel.
string | null
vereist
Een URL om het bestand te downloaden. Openbare bestanden krijgen een permanente CDN-URL, en privébestanden krijgen 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 via een niet-ondertekende CDN-URL. private-bestanden worden geleverd via 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 de afbeelding of video in pixels. Null wanneer niet beschikbaar of verwijderd door moderatie.
string | null
vereist
Tijdstip van verwijdering, of null voor een actief bericht.
boolean
vereist
object[]
vereist

Eigenschappen

integer | null
vereist
string | null
vereist
object[]
vereist

Eigenschappen

boolean
vereist
string
vereist
string
vereist
Footer die onderaan de embed wordt getoond. Null wanneer de embed geen footer heeft.

Eigenschappen

object | null
vereist
Kleine afbeelding die naast de footertekst wordt getoond. Null wanneer de footer geen pictogram heeft.

Eigenschappen

string | null
vereist
integer | null
vereist
string
vereist
integer | null
vereist
string
vereist
object | null
vereist

Eigenschappen

string | null
vereist
integer | null
vereist
string
vereist
integer | null
vereist
object | null
vereist

Eigenschappen

string | null
vereist
integer | null
vereist
string
vereist
integer | null
vereist
string | null
vereist
Tijdstip opgegeven door de auteur van de embed, als ISO 8601-tijdstempel in UTC. Null wanneer ontbrekend of ongeldig.
string | null
vereist
string | null
vereist
object[]
vereist
GIF’s die aan het bericht zijn toegevoegd. Leeg voor een verwijderd bericht.

Eigenschappen

integer
vereist
Hoogte van original_url, in pixels.
string
vereist
GIF op volledige grootte. HTTPS op een Klipy-mediahost.
string
vereist
Kleinere versie voor previews en placeholders. HTTPS op een Klipy-mediahost.
string
vereist
Identificatie van de GIF.
string
vereist
Titel van de GIF.
string
vereist
URL waarvandaan het bericht de GIF rendert. HTTPS op een Klipy-mediahost.
integer
vereist
Breedte van original_url, in pixels.

Eigenschappen

string | null
vereist
Paginabeschrijving, of null zolang niet beschikbaar.
string | null
vereist
URL van het sitepictogram, of null wanneer niet beschikbaar.
Aanvullende previewinformatie, of null wanneer niet beschikbaar.

Eigenschappen

string | null
vereist
string
vereist
string
vereist
string | null
vereist
URL van de previewafbeelding, of null wanneer niet beschikbaar.
boolean
vereist
Of de server deze preview nog aan het genereren is.
string | null
vereist
Paginatitel, of null zolang niet beschikbaar.
string
vereist
URL waarvan een preview wordt gemaakt.
string[]
vereist
string
vereist
Beschikbare opties: regular, system, automated
boolean
vereist
string | null
vereist
Ongeformatteerde berichttekst. null wanneer de tekst ontbreekt of het bericht is verwijderd
object | null
vereist

Eigenschappen

object[]
vereist

Eigenschappen

string
vereist
Identificatie van de optie binnen de poll.
string
vereist
integer
vereist
boolean
vereist
Of je op deze optie hebt gestemd.
object[]
vereist

Eigenschappen

string
vereist
Beschikbare opties: like, view, emoji
boolean
vereist
Of je met deze waarde hebt gereageerd.
integer
vereist
integer
vereist
string | null
vereist
De Unicode-emoji voor een emojireactie. Voor andere soorten reacties de waarde van de reactie.
object | null
Het bericht waarop wordt gereageerd. Weggelaten tenzij include_replying_to_message=true. Bevat alle berichtvelden behalve replying_to_message. null wanneer dit bericht is verwijderd of er geen doel in hetzelfde channel bestaat.
string | null
vereist
string | null
vereist
User-ID van de auteur van het bericht waarop wordt gereageerd, met prefix user_. null zonder antwoord in dit channel, of wanneer een van beide berichten is verwijderd.
string
vereist
Laatste wijziging van het bericht als ISO 8601-tijdstempel.
integer | null
vereist
Aantal weergaven van de experience. null voor channels op basis van DM’s.
ChatMessage