Respond.io
Visão geral
Seção intitulada “Visão geral”O Respond.io é uma plataforma de gerenciamento de conversas com clientes impulsionada por IA, que centraliza mensagens de múltiplos canais (WhatsApp, Instagram, e-mail e outros) em um único workspace. Com a integração no SquadOS, seus agentes podem criar e atualizar contatos, adicionar comentários internos a conversas, gerenciar etiquetas de organização, listar canais e usuários do workspace e recuperar mensagens específicas — tudo de forma automatizada.
- Site oficial: https://respond.io/
- Documentação na Composio: docs.composio.dev/toolkits/respond_io
Autenticação
Seção intitulada “Autenticação”Esta ferramenta utiliza chave de API (API_KEY) para conectar.
Você vai precisar dos seguintes campos:
| Campo | Obrigatório | Descrição |
|---|---|---|
api_key | Sim | Token de acesso gerado no painel do Respond.io em Configurações → Integrações → Developer API. |
Como obter a credencial
Seção intitulada “Como obter a credencial”- Acesse app.respond.io e faça login na sua conta.
- No menu lateral, abra o módulo Settings (Configurações).
- Acesse Integrations e localize Developer API na lista de integrações.
- Clique em Edit (Editar) ao lado de Developer API.
- Clique em Add Access Token para gerar um novo token de acesso.
- Copie o token gerado — esse é o valor a usar no campo
api_keyao conectar no SquadOS.
Como conectar no SquadOS
Seção intitulada “Como conectar no SquadOS”- Acesse Ferramentas no menu lateral (
/admin/tools). - Abra a aba Disponíveis e procure por
Respond.io. - Clique no card para abrir o modal de detalhes e em Conectar.
- Você é levado para a página de conexão segura hospedada pela Composio, onde informa o token de acesso obtido acima.
- Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)
Ações disponíveis
Seção intitulada “Ações disponíveis”Adicionar comentário interno à conversa
Seção intitulada “Adicionar comentário interno à conversa”RESPOND_IO_CREATE_COMMENT
Adiciona um comentário (nota interna) à conversa de um contato. Use após verificar o identificador do contato.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
text | string | Sim | Conteúdo do comentário (nota interna), com até 1000 caracteres. Você pode mencionar outros usuários usando {{@user.ID}}. |
identifier | string | Sim | Identificador do contato; pode ser id:<contact_id>, email:<email> ou phone:<E.164_phone>. Exemplo: id:123, email:abdc@gmail.com, phone:+60121233112. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar contato
Seção intitulada “Criar contato”RESPOND_IO_CREATE_CONTACT
Cria um novo contato no workspace do Respond.io com os detalhes especificados. O contato é identificado por e-mail, número de telefone ou ID de contato. Suporta adição de informações de perfil, preferências de idioma e campos personalizados pré-configurados no workspace.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
email | string | Não | Endereço de e-mail do contato. |
phone | string | Não | Número de telefone do contato incluindo código do país. |
language | string | Não | Código de idioma de duas letras ISO 639-1 (ex.: en para inglês, es para espanhol). |
lastName | string | Não | Sobrenome do contato. |
firstName | string | Sim | Nome do contato. |
identifier | string | Sim | Identificador único para o contato em um dos formatos: email:<email_address> (ex.: email:john@example.com), phone:<phone_number> (ex.: phone:+60121233112 com código do país), ou um ID de contato existente. |
profilePic | string | Não | URL da foto de perfil do contato. |
countryCode | string | Não | Código de país de duas letras ISO 3166-1 alpha-2 (ex.: US para Estados Unidos, MY para Malásia). |
custom_fields | array | Não | Lista de campos personalizados para o contato. Os campos personalizados devem existir no workspace antes de serem atribuídos a um contato. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar etiqueta no workspace
Seção intitulada “Criar etiqueta no workspace”RESPOND_IO_CREATE_SPACE_TAG
Cria uma nova etiqueta no workspace do Respond.io para organizar e categorizar contatos e conversas. As etiquetas ajudam na segmentação, filtragem e automação de fluxos de trabalho. Cada etiqueta deve ter um nome único dentro do workspace.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome da etiqueta. Deve ser único no workspace. Não pode conter emojis ou certos caracteres inválidos. Suporta espaços, letras, números e caracteres especiais comuns como !@#$%. |
color_code | string | Não | Código de cor hexadecimal para identificação visual da etiqueta na interface, ex.: #FF5733. Atenção: atualmente a API pode rejeitar este parâmetro com erros de validação. |
description | string | Não | Breve texto descrevendo a finalidade ou uso da etiqueta. Ajuda os membros da equipe a entender quando aplicar esta etiqueta. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter mensagem
Seção intitulada “Obter mensagem”RESPOND_IO_GET_MESSAGE
Recupera uma mensagem específica. Use quando precisar dos detalhes de uma mensagem enviada ou recebida de um contato.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
messageId | integer | Sim | ID único da mensagem a recuperar. |
identifier | string | Sim | Identificador do contato: pode ser um número de telefone (+60121233112), e-mail (abdc@gmail.com), ou ID de contato prefixado por id: (ex.: id:123). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar canais
Seção intitulada “Listar canais”RESPOND_IO_LIST_CHANNELS
Recupera a lista de canais conectados ao workspace, com suporte a paginação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | Não | Número de itens a retornar por página. Padrão: 10; máximo: 100. |
cursorId | integer | Não | Ponteiro para o ID do canal a partir do qual o próximo lote de registros deve começar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar usuários
Seção intitulada “Listar usuários”RESPOND_IO_LIST_USERS
Recupera a lista de usuários no workspace. Use quando precisar buscar todos os usuários para auditoria ou atribuição.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar etiqueta no workspace
Seção intitulada “Atualizar etiqueta no workspace”RESPOND_IO_UPDATE_SPACE_TAG
Atualiza uma etiqueta existente no workspace pelo seu nome atual. Você pode modificar o nome, a descrição ou o emoji da etiqueta. Atenção: códigos de cor não são suportados atualmente pela API e serão rejeitados se fornecidos. Pelo menos um campo além de currentName deve ser fornecido para efetuar a atualização.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Não | Novo nome para a etiqueta (se desejar renomeá-la). |
emoji | string | Não | Emoji a associar à etiqueta (caractere de emoji único). |
colorCode | string | Não | Código de cor hexadecimal para a etiqueta. Atenção: atualmente não suportado pela API — retornará erro se fornecido. |
currentName | string | Sim | Nome atual da etiqueta que deseja atualizar (deve corresponder exatamente). |
description | string | Não | Nova descrição para a etiqueta. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |