Enviar lista de opções
Método#
/send-option-list#
POST https://www.plugchat.com.br/api/whatsapp/send-text/send-option-list
Header#
Toda requisição http feita precisa passar sua header de autorização.#
| Key | Value |
|---|---|
| Authorization: | 1nEFbU3EktLnV7LIIzX |
Conceituação#
Neste método você poderá enviar mensagens de texto com uma lista de opções, onde o usuário poderá selecionar uma das opções enviadas.
IMPORTANTE
Esta funcionalidade está disponivel apenas para envios com contas Whatsapp NÃO COMERCIAL.
Atributos#
Obrigatórios#
| Atributos | Tipo | Descrição |
|---|---|---|
| phone | string | Telefone (ou ID do grupo para casos de envio para grupos) do destinatário no formato DDI DDD NUMERO Ex: 551199999999. IMPORTANTE Envie somente números, sem formatação ou máscara |
| message | string | Texto a ser enviado |
| optionList | optionList | Configuração da lista |
Opcionais#
| Atributos | Tipo | Descrição |
|---|---|---|
| delayMessage | number | Nesse atributo um delay é adicionado na mensagem. Você pode decidir entre um range de 1~15 sec, significa quantos segundos ele vai esperar para enviar a próxima mensagem. (Ex "delayMessage": 5, ). O delay default caso não seja informado é de 1~3 sec |
Option List#
| Atributos | Tipo | Descrição |
|---|---|---|
| title | string | Titulo da listagem |
| buttonLabel | string | Texto do botao que abre a lista |
| options | option | Litas de opções |
Option#
| Atributos | Tipo | Descrição |
|---|---|---|
| description | string | Descrição da opção |
| title | string | Titulo da opção |
Opcionais Button#
| Atributos | Tipo | Descrição |
|---|---|---|
| id | string | Identificador da opção |
Request Body#
Response#
200#
| Atributos | Tipo | Descrição |
|---|---|---|
| zaapId | string | id no z-api |
| messageId | string | id no whatsapp |
Exemplo
405#
Neste caso certifique que esteja enviando o corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no inicio deste tópico.
415#
Caso você receba um erro 415, certifique de adicionar na headers da requisição o "Content-Type" do objeto que você está enviando, em sua grande maioria "application/json"