Sobre

Os botões tem 3 valores, o nome do botão, a url da sua api e o método que será utilizado

(GET ou POST), na sua api é necessário esperar alguns atributos

(phone, name, genericFields, email, city, observation)

Atributos

POST

Se seu botão for do tipo POST enviaremos informações pelo body da requisição.

Request Body

Exemplo

{
"phone": "5544999999999",
"name": "Nome do contato",
"genericFields": [
{
"name": "nome do campo",
"value": "conteúdo do campo"
}
],
"email": "E-mail",
"city": "Cidade",
"observation": "Observação"
}

GET

Se seu botão for do tipo GET enviaremos informações pelos parâmetros da url da sua api.

Request Params

Exemplo

"URL_DA_SUA_API?phone={phone}&name={name}&genericFields={genericFields}&email={email}&city={city}&observation={observation}"

Response

3 tipos de resposta são esperados da sua api, 1º - message, em message estaremos esperando uma mensagem de texto, que será enviada no chat, 2º - modal, em modal estaremos esperando alguma informação que será exibida na tela para o usuário que clicou no botão, 3º - null, aqui apenas daremos um retorno se a chamada deu certo ou não.

Response Body

message

Em message esperamos um texto enviado por json, ele será encaminhado como uma mensagem direto pelo chat.

{
"message": "teste de mensagem"
}

modal

Em modal esperamos o retorno de um HTML ou de um texto para exibirmos em um card no chat do seu SpeedChat.

{
"modal": `<div class="bg-red-500"><span>Exemplo de retorno de modal</span></div>`
}

null

Em null esperamos o retorno vazio, apenas iremos dar uma informação visual que a chamada foi correta e nada mais será feita.

null