Skip to main content
En community kanal er chatten i en af en kontos Chat-experiences. En support kanal er en samtale mellem en konto og én kunde. Brug Channels API’et til at oprette og liste kanaler og til at hente én efter dens eget ID eller dens Chat-experiences ID. Du kan også acceptere eller afvise anmodninger om direkte beskeder, markere en kanal som læst og løse eller genåbne supportsamtaler.

Endpoints

Attributter

string
påkrævet
Eksisterende offentligt kanal-ID, bevaret på tværs af REST- og chatklienter.
string | null
påkrævet
string
påkrævet
Oprettelsestidspunkt som et ISO 8601-tidsstempel.
string | null
påkrævet
Hvornår kanalen blev slettet eller fjernet fra din kanalliste, som et ISO 8601-tidsstempel. Null for en aktiv kanal.
string | null
påkrævet
object | null
påkrævet
Kanalikonet. Community-kanaler viser experience-logoet med app-ikonet som reserve. Supportkanaler viser kontologoet. Private gruppekanaler viser deres eget ikon. Null for private en-til-en-kanaler, eller når der ikke er angivet et billede.

Egenskaber

string
påkrævet
Filens ID med præfikset file_.
string | null
påkrævet
BlurHash-pladsholder for et billede eller en video. Null, når den ikke er tilgængelig eller er fjernet af moderering.
string | null
påkrævet
Den oprindelige fils MIME-type, for eksempel application/pdf. Den bevares, når moderering fjerner filen.
string
påkrævet
Hvornår filen blev oprettet, som et ISO 8601-tidsstempel.
number | null
påkrævet
Lyd- eller videovarighed i sekunder. Null, når den ikke er tilgængelig eller er fjernet af moderering.
string | null
påkrævet
Det oprindelige filnavn inklusive filtypenavn.
integer | null
påkrævet
Billed- eller videohøjde i pixels. Null, når den ikke er tilgængelig eller er fjernet af moderering.
integer | null
Den bytestørrelse, hver del (undtagen den sidste) skal have. Kun til stede ved oprettelse og kun for multipart-uploads.
string | null
ID’et for multipart-uploadet, som sendes tilbage til complete. Kun til stede ved oprettelse og kun for multipart-uploads.
object[] | null
Den forhåndssignerede URL for hver del. Kun til stede ved oprettelse og kun for multipart-uploads.

Egenskaber

integer
påkrævet
Det 1-baserede indeks for denne del i multipart-uploadet.
string
påkrævet
Den forhåndssignerede URL, som denne dels bytes skal sendes til med PUT.
string
påkrævet
Typen af dette objekt, altid file.
boolean
påkrævet
Om moderering har fjernet filen. Når true, leverer url et erstatningsbillede. filename, size og content_type beskriver stadig den oprindelige fil.
integer | null
påkrævet
Filstørrelsen i bytes. null indtil uploadet er færdigt.
object
Headere, der skal sendes med upload-PUT’en. Kun til stede ved oprettelse.
string
påkrævet
Hvor filen er i sin uploadlivscyklus.Tilgængelige muligheder: pending, processing, ready, failed
string | null
Forhåndssigneret URL, som filens bytes skal sendes til med PUT. Kun til stede ved oprettelse og kun for uploads i én del.
string | null
påkrævet
En URL til at downloade filen. Offentlige filer får en permanent CDN-URL, og private filer får en signeret URL, der udløber. null indtil uploadet er færdigt. Når moderering fjerner filen, en URL til et erstatningsbillede.
string
påkrævet
public filer leveres fra en usigneret CDN-URL. private filer leveres fra en signeret URL, der udløber.Tilgængelige muligheder: public, private
string | null
påkrævet
URL til lydbølgeform. Null, når den ikke er tilgængelig eller er fjernet af moderering.
integer | null
påkrævet
Billed- eller videobredde i pixels. Null, når den ikke er tilgængelig eller er fjernet af moderering.
string
påkrævet
Tilgængelige muligheder: private, community, support
string | null
påkrævet
Hvornår kanalen sidst registrerede beskedaktivitet, som et ISO 8601-tidsstempel. Null, når der ikke er registreret beskedaktivitet.
string | null
påkrævet
object | null
påkrævet

Egenskaber

string | null
påkrævet
Gemt medlemskabs-ID eller null for adgangsafledte brugere.
string
påkrævet
string | null
påkrævet
Hvornår det gemte kanalmedlemskab blev oprettet, som et ISO 8601-tidsstempel. Null for brugere, hvis adgang ikke har et gemt medlemskab.
string | null
påkrævet
Din indbakketilstand for en privat kanal. null for andre brugere og andre kanaltyper.Tilgængelige muligheder: requested, accepted, hidden
string | null
påkrævet
Autoriseret deltagers læseposition. Community-positioner er kun synlige for brugeren selv.
string | null
påkrævet
Tilgængelige muligheder: all, mentions, none
integer | null
påkrævet
boolean | null
påkrævet
Din ulæst-tilstand for kanalen. null for andre brugere.
string | null
påkrævet
Hvornår det gemte kanalmedlemskab sidst blev ændret, som et ISO 8601-tidsstempel. Null for brugere, hvis adgang ikke har et gemt medlemskab.
object
påkrævet

Egenskaber

string
påkrævet
Bruger-ID med præfikset user_.
string | null
påkrævet
Visningsnavn.
object
påkrævet
Avatar-wrapper. Dens url er altid til stede og er en genereret pladsholder, når brugeren ikke har angivet et billede.

Egenskaber

string
påkrævet
Avatarbillede-URL. Altid til stede. Det er en genereret pladsholder, når brugeren ikke har angivet et billede.
string
påkrævet
Offentligt brugernavn.
string
påkrævet
Bruger-ID
object | null
påkrævet

Egenskaber

boolean
påkrævet
Forhindr medlemmer i at poste medier.
boolean
påkrævet
Forhindr medlemmer i at poste links.
string[] | null
påkrævet
Ord, der er blokeret i kanalen. null, når du ikke kan se denne indstilling; en tom liste betyder, at ingen ord er blokeret.
integer | null
påkrævet
Sekunder, et medlem skal vente mellem beskeder. 0 eller null slår ventetiden fra.
string
påkrævet
Hvem der kan poste beskeder.Tilgængelige muligheder: everyone, admins
string
påkrævet
Hvem der kan reagere på beskeder.Tilgængelige muligheder: everyone, no_one
string | null
påkrævet
boolean
påkrævet
Om app-notifikationer er slået til. Webhooks udløses uanset hvad.
object | null
påkrævet

Egenskaber

boolean
påkrævet
string
påkrævet
string | null
påkrævet
Tilgængelige muligheder: customer, support
string | null
påkrævet
Hvornår supportsamtalen blev løst, som et ISO 8601-tidsstempel. Null mens den er uløst.
string
påkrævet
Tilgængelige muligheder: unresolved, resolved
string
påkrævet
Seneste kanalændring som et ISO 8601-tidsstempel.
Channel