Zum Hauptinhalt springen

Text-Channel-Messaging

Diese Seite erklärt, wie Channel-Messaging für Integrationen funktioniert: wie Sie Channels entdecken, den Unterschied zwischen Posten in einen Channel und Senden einer Direktnachricht, die unterstützte Markdown-Teilmenge, die Teilnehmer-Berechtigungsregel und die Antwort jedes Aufrufs. Für eine schnelle Orientierung und Copy-Paste-Beispiele beginnen Sie mit der Channels-Einführung.

Channels listen​

Der list channels-Endpunkt liefert die Channels, die Ihr Token sehen kann, mit optionalen Filtern:

  • q — groß-/kleinschreibungsunabhängige Suche über Channel-Name, Beschreibung und Teilnehmername/E-Mail.
  • type — category, text, voice, inbox, classroom, meeting oder whatsapp.
  • kind — group oder dm.
  • participantId — Channels, die einen bestimmten Benutzer oder ein Team enthalten.
  • limit / offset — Ergebnisse seitenweise (limit 1–200, Standard 100).

Jeder Channel enthält ID, Name, Typ, Kind, Teilnehmer-User-/Team-IDs und Zeitstempel — genug, um die channelId zu finden, in die Sie posten wollen.

Channel-Nachricht senden​

POST an den send-message-Endpunkt des Channels mit der channelId im Pfad und einem Body message (Markdown, bis 10.000 Zeichen):

curl -X POST "https://api.copera.ai/public/v1/chat/channel/{channelId}/send-message" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "message": "Deploy to production finished ✅" }'

Ein erfolgreicher Send liefert 204 No Content.

Nachrichten unterstützen eine Markdown-Teilmenge — Überschriften, Fett/Kursiv, geordnete und ungeordnete Listen, Inline- und Block-Code, Zitate, horizontale Linien und Links.

hinweis

Eine Integration kann nur in Channels posten, in denen sie Teilnehmer ist. Fügen Sie Ihre Integration zuerst dem Ziel-Channel hinzu.

Direktnachricht senden​

POST an den direct-message-Endpunkt mit der userId des Empfängers und einer message (bis 10.000 Zeichen). Copera erstellt oder nutzt den DM-Channel für Sie:

curl -X POST "https://api.copera.ai/public/v1/chat/direct-message/send-message" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "userId": "<member id>", "message": "Your report is ready." }'

Die DM wird in die Queue gestellt und die Antwort (202 Accepted) liefert die aufgelöste channelId. Um die userId eines Empfängers zu finden, nutzen Sie den Endpunkt Workspace-Members mit einer q-Suche.

Authentifizierung​

Channel-Endpunkte akzeptieren ein volles Personal Access Token (cp_pat_) oder einen Integration API Key (cp_key_) mit dem Scope access_channels. Siehe Authentifizierung für Token-Typen.

Referenz​