Listar usuários no Slack, por uma API
Lista os membros do workspace com id, name, real_name e profile.email, incluindo bots (is_bot) e membros desativados (deleted). A resposta tem members e response_metadata.next_cursor: passe-o como cursor para ler a próxima página.
- Identificador
- slack_list_users
A chamada
POST https://connect.reportei.com/api/tools/slack_list_users/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"limit": 1
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| limit | integer | Não | Members per page, for example 200. Without it Slack tries to return everyone at once, which fails on large workspaces. |
| cursor | string | Não | The response_metadata.next_cursor of the previous response. |
| include_locale | boolean | Não | true adds the locale of each member. |
Conexões possíveis
O seu cliente conecta a conta do Slack uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
OAuth com o app do seu produto
Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/slack, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/slack_list_users. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Slack
- Listar conversasGETLista os canais do workspace: todos os canais públicos e os privados a que o app foi adicionado. O id de um canal é o argumento channel das outras tools, e is_member diz se o app está nele. A resposta tem channels e response_metadata.next_cursor: passe-o como cursor para ler a próxima página.
- Criar conversaPOSTCria um canal público ou privado com o app como membro e o retorna com seu id. Adicione pessoas a ele com Invite members to conversation.
- Entrar em conversaPOSTAdiciona o app a um canal público e retorna o canal. O app precisa ser membro para ler as mensagens de um canal ou postar nele. Um canal privado não pode ser acessado assim: um membro adiciona o app a ele no Slack.
- Convidar membros para a conversaPOSTConvida membros do workspace para um canal em que o app está. Se um dos ids falhar, ninguém é convidado, a menos que force seja true.
- Listar mensagensGETLista as mensagens de um canal de que o app é membro, da mais nova para a mais antiga. Respostas de thread não são incluídas: leia-as com List thread replies. A resposta tem messages, has_more e response_metadata.next_cursor: passe-o como cursor para ler a próxima página. Um app instalado fora do Slack Marketplace pode ficar limitado a 15 mensagens por chamada e uma chamada por minuto.
- Listar respostas de threadGETLista uma thread de um canal de que o app é membro: a mensagem principal seguida de suas respostas. A resposta tem messages, has_more e response_metadata.next_cursor: passe-o como cursor para ler a próxima página. Um app instalado fora do Slack Marketplace pode ficar limitado a 15 mensagens por chamada e uma chamada por minuto.
- Enviar mensagemPOSTPosta uma mensagem como o bot do app e a retorna com channel e ts, o par que Update message e Delete message pedem. Envie text, markdown_text ou blocks. O app precisa ser membro do canal: chame Join conversation antes em um canal público.
- Agendar mensagemPOSTAgenda uma mensagem do bot do app para um momento até 120 dias à frente e retorna seu scheduled_message_id. Envie text, markdown_text ou blocks. O app precisa ser membro do canal, e um canal aceita no máximo 30 mensagens agendadas dentro dos mesmos 5 minutos.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
