Pular para o conteúdo

Regras de Automacao

Configure regras automaticas que executam acoes quando determinadas condicoes sao atendidas. Automacoes podem atribuir conversas, adicionar etiquetas, enviar emails e mais.

GET/api/v1/accounts/{account_id}/automation_rules

Lista todas as regras de automacao da conta.

bash
curl -s "https://chat.seudominio.com/api/v1/accounts/1/automation_rules" \
  -H "api_access_token: YOUR_TOKEN" | jq .
200Lista de regras
json
{
  "payload": [
    {
      "id": 1,
      "name": "Auto-atribuir VIP",
      "description": "Atribui conversas de clientes VIP para equipe premium",
      "event_name": "conversation_created",
      "account_id": 1,
      "conditions": [...],
      "actions": [...]
    }
  ]
}
POST/api/v1/accounts/{account_id}/automation_rules

Cria uma nova regra de automacao.

Body

NomeTipoObrigatorioDescricao
namestringSimNome da regra
descriptionstringNaoDescricao da regra
event_namestringSimEvento gatilho: conversation_created, conversation_updated, message_created
conditionsarraySimArray de condicoes para ativar a regra
actionsarraySimArray de acoes a executar
bash
curl -X POST "https://chat.seudominio.com/api/v1/accounts/1/automation_rules" \
  -H "api_access_token: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Auto-atribuir por inbox",
    "event_name": "conversation_created",
    "conditions": [
      {
        "attribute_key": "inbox_id",
        "filter_operator": "equal_to",
        "values": [1],
        "query_operator": null
      }
    ],
    "actions": [
      {
        "action_name": "assign_team",
        "action_params": [2]
      },
      {
        "action_name": "add_label",
        "action_params": ["whatsapp"]
      }
    ]
  }'
GET/api/v1/accounts/{account_id}/automation_rules/{id}

Retorna os detalhes de uma regra de automacao.

bash
curl -s "https://chat.seudominio.com/api/v1/accounts/1/automation_rules/1" \
  -H "api_access_token: YOUR_TOKEN" | jq .
PATCH/api/v1/accounts/{account_id}/automation_rules/{id}

Atualiza uma regra de automacao existente.

Body

NomeTipoObrigatorioDescricao
namestringNaoNome da regra
conditionsarrayNaoCondicoes atualizadas
actionsarrayNaoAcoes atualizadas
DELETE/api/v1/accounts/{account_id}/automation_rules/{id}

Remove uma regra de automacao.

bash
curl -X DELETE "https://chat.seudominio.com/api/v1/accounts/1/automation_rules/1" \
  -H "api_access_token: YOUR_TOKEN"

Condicoes e Acoes

Eventos Gatilho

EventoDescricao
conversation_createdQuando uma nova conversa e criada
conversation_updatedQuando uma conversa e atualizada
message_createdQuando uma nova mensagem e recebida

Acoes Disponiveis

AcaoDescricao
assign_agentAtribuir a um agente especifico
assign_teamAtribuir a uma equipe
add_labelAdicionar etiqueta
remove_labelRemover etiqueta
send_emailEnviar email de notificacao
mute_conversationSilenciar notificacoes da conversa
change_statusAlterar status (open, resolved, pending)
change_priorityAlterar prioridade