Pular para o conteúdo

Respostas Rapidas

Crie e gerencie respostas pre-definidas que agentes podem usar rapidamente durante o atendimento. Agentes digitam um atalho para inserir a resposta completa.

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

Lista todas as respostas rapidas da conta.

Parametros

NomeTipoObrigatorioDescricao
search(query)stringNaoBuscar por short_code ou conteudo
bash
curl -s "https://chat.seudominio.com/api/v1/accounts/1/canned_responses" \
  -H "api_access_token: YOUR_TOKEN" | jq .
200Lista de respostas rapidas
json
[
  {
    "id": 1,
    "short_code": "saudacao",
    "content": "Ola! Obrigado por entrar em contato. Como posso ajudar hoje?",
    "account_id": 1
  },
  {
    "id": 2,
    "short_code": "horario",
    "content": "Nosso horario de atendimento e de segunda a sexta, das 8h as 18h.",
    "account_id": 1
  }
]
POST/api/v1/accounts/{account_id}/canned_responses

Cria uma nova resposta rapida.

Body

NomeTipoObrigatorioDescricao
short_codestringSimAtalho para invocar a resposta (sem espacos)
contentstringSimTexto completo da resposta
bash
curl -X POST "https://chat.seudominio.com/api/v1/accounts/1/canned_responses" \
  -H "api_access_token: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "short_code": "obrigado",
    "content": "Obrigado pelo contato! Foi um prazer ajudar. Caso tenha mais duvidas, estamos a disposicao."
  }'
PATCH/api/v1/accounts/{account_id}/canned_responses/{id}

Atualiza uma resposta rapida existente.

Body

NomeTipoObrigatorioDescricao
short_codestringNaoNovo atalho
contentstringNaoNovo conteudo
DELETE/api/v1/accounts/{account_id}/canned_responses/{id}

Remove uma resposta rapida.

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