SDK - Chatbot

Funções do SDK

Envio de textos e multimídias

Essas funções são utilizadas para interagir com o SDK e enviar mensagens formatadas de diferentes tipos, como texto, imagem, arquivo, vídeo, áudio e link.

sdk.send.text("seu texto")

sdk.send.image(url)

sdk.send.file(url)

sdk.send.video(url)

sdk.send.audio(url)

sdk.send.link("Texto","Url")

Envio de multimídia passando Headers - Criação de URL

sdk.chatbot.externalMedia(method, url, options, body)

Aqui é feito uma chamada à uma api externa e utiliza-se dos parâmetros (method, url, options e body) para requisitar os dados dessa api.

Exemplo de caso de uso:

  const method = 'GET'
  
  const url = `www.backendcliente.xx.gov.br/certidao/pdf? idProfissional=${idProfissional}`
  
  const options = {
    headers: {
      'Authorization': token,
      'Application': 4
    }
  }
  
  const body = {
    'chave': 'valor'
  }

  const res = await sdk.chatbot.externalMedia(method, url, options, body)
  res = { chatbotExternalMedia, error } 

  chatbotExternalMedia: String | null  (Link de acesso à mídia externa) 
  error: Error | null

Neste exemplo, por meio do método GET (solicitação de dados), é feita uma requisição de um link externo passando um parâmetro pela URL, e através das 'options' são incluídos os cabeçalhos (headers) com informações de autorização. Já no 'body', é passada a chave e o valor. A constante 'res' faz a chamada à API, que possui o link externo solicitado.

O resultado da chamada à API pode ter duas propriedades: 'chatbotExternalMedia', que pode ser uma string ou nulo. Se a resposta for bem-sucedida, será retornado o link. Caso contrário, a propriedade 'error', que é um objeto de erro ou nulo, conterá informações sobre o erro ocorrido.

Construção dinâmica de botões

sdk.send.buttons("Titulo acima dos botões",[
  {
    title:"Primeiro botão",
    payload:"Primeiro botão",
    without_bold:true
  },
  {
    title:"Segundo botão",
    payload:"Segundo botão",
    without_bold:true
  }