Como enviar chamadas ao Shazan via API

Introdução

A API SHAZAN.AI permite a interação com um agente virtual de IA através de chamadas HTTP POST. Com essa API, é possível enviar mensagens e receber respostas automáticas, identificar telefones e e-mails, agendar visitas e encaminhar conversas para atendimento humano quando necessário.

Endpoint

URL: https://api.shazan.ai/webhook/shazan-api

Método: POST

Estrutura da Requisição

A chamada à API deve ser feita enviando um JSON no corpo da requisição com os seguintes campos:

Parâmetro	Tipo	Obrigatório	Descrição
origin	string	Não	Origem da chamada, usada para relatórios e identificação da fonte da interação.
name	string	Não	Nome do cliente que está interagindo com o agente.
phone	string	Não	Número de telefone do cliente.
message	string	Sim	Mensagem a ser processada pelo agente.
roomid	string	Não	Identificação da sala. Caso não seja enviado, a API gerará uma nova.
agid	string	Sim	ID do agente de atendimento dentro da plataforma SHAZAN.AI.

Exemplo de Requisição

{
    "origin": "chat-widget",
    "name": "João Silva",
    "phone": "551199998888",
    "message": "tudo bem?",
    "roomid": "33",
    "agid": "17379xxx837660x6xxx748887514546200"
}

Estrutura da Resposta

A API retorna um JSON contendo os seguintes campos:

Parâmetro	Tipo	Descrição
response	string	Mensagem de resposta do agente SHAZAN.AI.
visit_date	string	Data da visita agendada, caso tenha sido marcada.
visit	boolean	Indica se houve agendamento de visita (true ou false).
human	boolean	Indica se a mensagem deve ser transferida para um atendente humano (true ou false).
name	string	Se o SHAZAN.AI identificou um nome do cliente na mensagem, ele será retornado aqui.
phone	string	Se o SHAZAN.AI identificou um telefone na mensagem, ele será retornado aqui.
email	string	Se o SHAZAN.AI identificou um e-mail na mensagem, ele será retornado aqui.
roomid	string	ID da sala utilizada para próximas mensagens.
messageid	string	ID da mensagem, para referência e rastreamento.

Exemplo de Resposta

{
    "response": "Tudo bem, sim! 😊 E você? Sobre o que você gostaria de conversar? Algum interesse em nossos espaços para eventos ou estúdios?",
    "visit_date": "",
    "visit": false,
    "human": false,
    "name": "joao antonio",
    "phone": "",
    "email": "",
    "roomid": "shazan-yay5ccc0i4h",
    "messageid": "1c5cxe663r734pm"
}

Considerações Finais

A API SHAZAN.AI é ideal para integração em sistemas de atendimento automatizado, oferecendo um serviço rápido e eficiente para interações automatizadas com clientes. Para maiores informações sobre limites de requisições e autenticação, consulte a documentação oficial ou entre em contato com o suporte SHAZAN.AI.