Klivo Chat API › Application APIs

Respostas Prontas

Gerencie as canned responses (respostas rápidas) da sua conta via API.

GET

Listar Respostas Prontas

Retorna todas as respostas prontas. Suporta busca por conteúdo.

GET
https://chat.klivo.marketing/api/v1/accounts/{account_id}/canned_responses
Parâmetros de Path
account_id integer obrigatório
ID da conta.
Query Parameters
search string
Busca por atalho ou conteúdo da resposta.
CURL 
curl --request GET \
  --url https://chat.klivo.marketing/api/v1/accounts/{account_id}/canned_responses?search=saudacao \
  --header 'api_access_token: '
200 
[
  {
    "id": 1,
    "short_code": "saudacao",
    "content": "Olá! Sou o {{agent.name}}. Como posso ajudar?"
  }
]
POST

Criar Resposta Pronta

Cria uma nova resposta pronta.

POST
https://chat.klivo.marketing/api/v1/accounts/{account_id}/canned_responses
Parâmetros de Path
account_id integer obrigatório
ID da conta.
Body Parameters
short_code string obrigatório
Atalho (sem espaços, sem /).
content string obrigatório
Conteúdo da resposta. Aceita variáveis: {{contact.name}}, {{agent.name}}.
CURL 
curl --request POST \
  --url https://chat.klivo.marketing/api/v1/accounts/{account_id}/canned_responses \
  --header 'api_access_token: ' \
  --header 'Content-Type: application/json' \
  --data '{
  "short_code": "horario",
  "content": "Nosso horário é segunda a sexta, das 9h às 18h."
}'
200 
{
  "id": 2,
  "short_code": "horario",
  "content": "Nosso horário é segunda a sexta, das 9h às 18h."
}
DELETE

Excluir Resposta Pronta

Remove uma resposta pronta.

DELETE
https://chat.klivo.marketing/api/v1/accounts/{account_id}/canned_responses/{id}
Parâmetros de Path
account_id integer obrigatório
ID da conta.
id integer obrigatório
ID da resposta pronta.
CURL 
curl --request DELETE \
  --url https://chat.klivo.marketing/api/v1/accounts/{account_id}/canned_responses/{id} \
  --header 'api_access_token: '
200 
{
  "message": "Canned Response deleted"
}