Skip to content
ver .md original

Canais de relatório

Descubra canais de chat disponíveis para `report_channels` ao criar ou configurar formulários e check-ins. Os IDs de canal deste endpoint alimentam payloads de authoring (máx. 3 por recurso).

GET/v1/report-channels/Chave de APICLI Auth

Listar canais de relatório disponíveis

Retorna canais de chat disponíveis para report_channels.

Parâmetros de consulta

NomeTipoObrigatórioDescrição
namestringOpcionalFiltro por prefixo do nome
limitintegerOpcionalMáximo de canais

Resposta

{
  "channels": "array",
  "total": "integer"
}

Erros

StatusQuando
401Credencial ausente ou inválida
403Permissões insuficientes (admin/manager necessário para escrita)
429Limite de taxa — cabeçalho Retry-After definido
curl -sS 'https://api.dailybot.com/v1/report-channels/?name=general' -H 'X-API-KEY: $DAILYBOT_API_KEY'

Testar

Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.

  • CLI: dailybot channels list. Máx. 3 canais por form/check-in.

Canais de relatório

Descubra canais de chat disponíveis para report_channels ao criar ou configurar formulários e check-ins. Os IDs de canal deste endpoint alimentam payloads de authoring (máx. 3 por recurso).

Autenticação: header X-API-KEY ou Authorization: Bearer <cli_token> com capacidade de leitura.

Resumo dos endpoints

Método Endpoint Descrição
GET /v1/report-channels/ Listar canais de relatório disponíveis

GET /v1/report-channels/

Retorna canais de chat (Slack, Microsoft Teams, Discord, Google Chat) disponíveis para report_channels em formulários e check-ins. Use os valores id do canal ao criar ou editar.

Parâmetros de consulta

Nome Tipo Obrigatório Descrição
name string Não Filtro por prefixo do nome do canal.
limit integer Não Máximo de canais a retornar.
curl -sS 'https://api.dailybot.com/v1/report-channels/?name=general' \
  -H 'X-API-KEY: $DAILYBOT_API_KEY'

Resposta (200 OK):

{
  "channels": [
    {
      "id": "channel-uuid",
      "name": "general",
      "platform": "slack"
    }
  ],
  "total": 1
}

Resposta (401 Unauthorized): Credencial ausente ou inválida.

Resposta (403 Forbidden): Permissões insuficientes.

Resposta (429 Too Many Requests): Limite de taxa — cabeçalho Retry-After definido.

Equivalente na CLI

dailybot channels list

Notas

  • Máximo 3 canais de relatório por formulário ou check-in.
  • Os IDs de canal devem existir nesta lista ao definir report_channels em payloads de criação ou config patch.