Métodos disponíveis

Lista os métodos da API e os endpoints disponíveis para integração com a plataforma Laiye Chatbot.

Updated on 24 de setembro de 2026

Método	Descrição
isOpen	`DestygoChat.isOpen()` retorna `true` se a caixa de chat do widget estiver aberta e `false` caso contrário.
wasOpened	`DestygoChat.wasOpened()` retorna `true` se a caixa de chat do widget tiver sido aberta anteriormente e `false` caso contrário.
unreadMessagesCount	`DestygoChat.unreadMessagesCount()` retorna o número de mensagens não lidas. Uma mensagem não é lida se tiver sido recebida enquanto a caixa de chat estava fechada e não tiver sido aberta desde então.
messages	`DestygoChat.messages()` retorna a lista de mensagens do widget atual. O resultado é um array com as duas possibilidades de objeto a seguir: `{ "author": "'user'\|\|'server'", "text": "the text of the message" }` `{ "author": "'user'\|\|'server'", "attachment": {type: "template", payload: {…}} }`O autor pode ser `user` ou `server`. Haverá `text` ou `attachment` no payload. Um anexo é um dado JSON de template.
MarkMessagesAsRead	`DestygoChat.MarkMessagesAsRead()` marca todas as mensagens não lidas como lidas.
ToggleChat	Parâmetro opcional: open (boolean) `DestygoChat.ToggleChat()` abre ou fecha a caixa de chat dependendo do parâmetro. * `DestygoChat.ToggleChat()` abrirá a caixa de chat se ela estiver fechada e a fechará se estiver aberta. * `DestygoChat.ToggleChat({open: true})` abrirá a caixa de chat independentemente do estado atual. * `DestygoChat.ToggleChat({open: false})` fechará a caixa de chat independentemente do estado atual.
SendMessage	Parâmetro obrigatório: mensagem de texto (string) `DestygoChat.SendMessage('a text message')` enviará uma mensagem de texto ao bot.
ResetWidget	`DestygoChat.ResetWidget()` redefine o estado do widget, como se fosse um usuário totalmente novo.
setZendeskUserInfo	Parâmetro obrigatório: informações do usuário: display_name, email, phone (Object) O parâmetro de objeto pode conter apenas estes três parâmetros: display_name, email, phone. Essa restrição vem do Zendesk e não podemos adicionar outros campos. `DestygoChat.setZendeskUserInfo(UserInfoObject)` enviará as informações do usuário ao Zendesk antes da transferência para o agente. Você precisa usar esta função quando o seguinte evento for acionado: `destygo_zendesk_triggered`

Was this article helpful?

Método

Descrição

isOpen

DestygoChat.isOpen() retorna true se a caixa de chat do widget estiver aberta e false caso contrário.

wasOpened

DestygoChat.wasOpened() retorna true se a caixa de chat do widget tiver sido aberta anteriormente e false caso contrário.

unreadMessagesCount

DestygoChat.unreadMessagesCount() retorna o número de mensagens não lidas. Uma mensagem não é lida se tiver sido recebida enquanto a caixa de chat estava fechada e não tiver sido aberta desde então.

messages

DestygoChat.messages() retorna a lista de mensagens do widget atual. O resultado é um array com as duas possibilidades de objeto a seguir: { "author": "'user'||'server'", "text": "the text of the message" } { "author": "'user'||'server'", "attachment": {type: "template", payload: {…}} }O autor pode ser user ou server. Haverá text ou attachment no payload. Um anexo é um dado JSON de template.

MarkMessagesAsRead

DestygoChat.MarkMessagesAsRead() marca todas as mensagens não lidas como lidas.

ToggleChat

Parâmetro opcional: open (boolean) DestygoChat.ToggleChat() abre ou fecha a caixa de chat dependendo do parâmetro. * DestygoChat.ToggleChat() abrirá a caixa de chat se ela estiver fechada e a fechará se estiver aberta. * DestygoChat.ToggleChat({open: true}) abrirá a caixa de chat independentemente do estado atual. * DestygoChat.ToggleChat({open: false}) fechará a caixa de chat independentemente do estado atual.

SendMessage

Parâmetro obrigatório: mensagem de texto (string) DestygoChat.SendMessage('a text message') enviará uma mensagem de texto ao bot.

ResetWidget

DestygoChat.ResetWidget() redefine o estado do widget, como se fosse um usuário totalmente novo.

setZendeskUserInfo

Parâmetro obrigatório: informações do usuário: display_name, email, phone (Object) O parâmetro de objeto pode conter apenas estes três parâmetros: display_name, email, phone. Essa restrição vem do Zendesk e não podemos adicionar outros campos. DestygoChat.setZendeskUserInfo(UserInfoObject) enviará as informações do usuário ao Zendesk antes da transferência para o agente. Você precisa usar esta função quando o seguinte evento for acionado: destygo_zendesk_triggered

Search the help center…

Search the help center…