Respostas Rápidas

Crie e gerencie respostas pré-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 rápidas da conta.

Parâmetros

Nome	Tipo	Obrigatorio	Descricao
`search`(query)	`string`	Nao	Buscar por short_code ou conteúdo

bash

curl -s "https://chat.seudominio.com/api/v1/accounts/1/canned_responses" \
  -H "api_access_token: YOUR_TOKEN" | jq .

200Lista de respostas rápidas

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 horário 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 rápida.

Body (envolto em objeto canned_response)

Nome	Tipo	Obrigatorio	Descricao
`short_code`	`string`	Sim	Atalho para invocar a resposta (único por conta)
`content`	`string`	Sim	Texto 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 '{
    "canned_response": {
      "short_code": "obrigado",
      "content": "Obrigado pelo contato! Foi um prazer ajudar."
    }
  }'

PATCH/api/v1/accounts/{account_id}/canned_responses/{id}

Atualiza uma resposta rápida existente.

Body (envolto em objeto canned_response)

Nome	Tipo	Obrigatorio	Descricao
`short_code`	`string`	Nao	Novo atalho
`content`	`string`	Nao	Novo conteúdo

DELETE/api/v1/accounts/{account_id}/canned_responses/{id}

Remove uma resposta rápida.

bash

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