Pular para o conteúdo principal

Mensagens em Text Channel

Esta página explica como funcionam as mensagens em channels para integrações: como descobrir channels, a diferença entre postar em um channel e enviar uma mensagem direta, o subconjunto de markdown que as mensagens suportam, a regra de permissão de participante e a response que cada chamada retorna. Para uma orientação rápida e exemplos prontos para copiar e colar, comece pela introdução de Channels.

Listando channels

O endpoint list channels retorna os channels que seu token pode ver, com filtros opcionais:

  • q — busca case-insensitive no nome do channel, na descrição e no nome/email dos participantes.
  • typecategory, text, voice, inbox, classroom, meeting ou whatsapp.
  • kindgroup ou dm.
  • participantId — channels que incluem um usuário ou time específico.
  • limit / offset — paginação pelos resultados (limit 1–200, padrão 100).

Cada channel inclui seu id, nome, type, kind, ids de usuário/time participantes e timestamps — o suficiente para descobrir o channelId no qual você precisa postar.

Enviando uma mensagem em um channel

POST no endpoint send-message do channel com o channelId no path e um body message (markdown, até 10.000 caracteres):

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

Um envio bem-sucedido retorna 204 No Content.

As mensagens suportam um subconjunto de markdown — headings, negrito/itálico, listas ordenadas e não ordenadas, código inline e em bloco, blockquotes, linhas horizontais e links.

observação

Uma integração só pode postar em channels dos quais é participante. Adicione sua integração ao channel de destino primeiro.

Enviando uma mensagem direta

POST no endpoint direct-message com o userId do destinatário e uma message (até 10.000 caracteres). O Copera cria ou reutiliza o channel de DM para você:

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

A DM é enfileirada e a response (202 Accepted) retorna o channelId resolvido. Para encontrar o userId de um destinatário, use o endpoint de membros do Workspace com uma busca q.

Autenticação

Endpoints de channel aceitam um Personal Access Token completo (cp_pat_) ou uma API key de integração (cp_key_) com o escopo access_channels. Veja Autenticação para tipos de token.

Referência