Vai al contenuto principale

Messaggistica text channel

Questa pagina spiega come funziona la messaggistica di channel per le integrazioni: come scoprire i channel, la differenza tra pubblicare su un channel e inviare un messaggio diretto, il subset markdown supportato dai messaggi, la regola di permesso participant e la response che ciascuna chiamata restituisce. Per un orientamento rapido ed esempi copy-paste, parti dall'introduzione Channels.

Elencare i channel​

L'endpoint list channels restituisce i channel che il token può vedere, con filtri opzionali:

  • q — ricerca case-insensitive su nome channel, description e nome/email del participant.
  • type — category, text, voice, inbox, classroom, meeting o whatsapp.
  • kind — group o dm.
  • participantId — channel che includono un utente o team specifico.
  • limit / offset — scorre i risultati (limit 1–200, default 100).

Ogni channel include id, name, type, kind, participant user/team id e timestamp — abbastanza per scoprire il channelId a cui pubblicare.

Inviare un messaggio di channel​

POST all'endpoint send-message del channel con il channelId nel path e un body message (markdown, fino a 10.000 caratteri):

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 ✅" }'

Un invio riuscito restituisce 204 No Content.

I messaggi supportano un subset di markdown — heading, grassetto/corsivo, liste ordinate e non ordinate, codice inline e a blocco, citazioni, regole orizzontali e link.

nota

Un'integrazione può pubblicare solo sui channel di cui è participant. Aggiungi prima l'integrazione al channel di destinazione.

Inviare un messaggio diretto​

POST all'endpoint direct-message con lo userId del destinatario e un message (fino a 10.000 caratteri). Copera crea o riusa il channel DM per te:

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." }'

Il DM viene messo in coda e la response (202 Accepted) restituisce il channelId risolto. Per trovare lo userId di un destinatario, usa l'endpoint Workspace members con una search q.

Autenticazione​

Gli endpoint Channel accettano un Personal Access Token completo (cp_pat_) o un'integration API key (cp_key_) con lo scope access_channels. Vedi Autenticazione per i tipi di token.

Riferimento​