Como usar?

Sobre#

Os botões tem 3 valores, o nome do botão, a url da sua api e o método que sera utilizado ( GET ou POST), na sua api é necessário esperar alguns atributos (phone, name, genericFields, email, city, observation)

caution

É obrigatório receber corretamente todos os atributos e retornar exatamente o que esperamos, do contrário a chamada da sua api não irá acontecer

Atributos#

Atributos	Tipo	Descrição
phone	string	Número de telefone do contato selecionado
name	string	Nome do contato selecionado
genericFields	Array[]	Array de objetos com nome e valor dos campos personalizados
email	string	E-mail do contato selecionado
city	string	Cidade do contato selecionado
observation	string	Observação do contato selecionado

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 parametros 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.

important

Sua api deve obrigatóriamente retornar um json, tendo corpo 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 PlugChat

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

important

Também é possível utilizar CSS no seu HTML, podendo ser CSS puro ou as tags do TailwindCSS

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

caution

É obrigatório retornar o atributo Null caso não queira nenhuma ação da sua api