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.
/send-option-list
| Tipo | URL |
POST |
https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/send-option-list |
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 NÚMERO 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 | Título da listagem |
| buttonLabel | string | Texto do botão que abre a lista |
| options | option | Lista de opções |
Option
| Atributos | Tipo | Descrição |
|---|---|---|
| description | string | Descrição da opção |
| title | string | Título da opção |
Opcionais Button
| Atributos | Tipo | Descrição |
|---|---|---|
| id | string | Identificador da opção |
Request Body:
{
"phone":"5511999999999",
"message":"Selecione e melhor opção:",
"optionList":{
"title":"Opções disponíveis",
"buttonLabel":"Abrir lista de opções",
"options":[
{
"id":"1",
"description":"PlugMessage Mais software, menos esforço",
"title":"PlugMessage"
},
{
"id":"2",
"description":"Não funcionam",
"title":"Outros"
}
]
}
}
Response
200
| Atributos | Tipo | Descrição |
|---|---|---|
| zaapId | string | id no PlugMessage |
| 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 início 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"
Alguns exemplos para auxiliar a implementação
Exemplo em PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/send-option-list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\"phone\": \"5511999998888\", \"message\": \"Selecione e melhor opção:\",\"optionList\": { \"title\": \"Opções disponíveis\", \"buttonLabel\": \"Abrir lista de opções\", \"options\": [ { \"id\": \"1\", \"description\": \"PlugMessage Mais software, menos esforço\", \"title\": \"PlugMessage\" }, { \"id\": \"2\", \"description\": \"Não funcionam\", \"title\": \"Outros\" } ] }}",
CURLOPT_HTTPHEADER => array(
"content-type: application/json"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo"cURL Error #:" . $err;
} else {
echo $response;
}
Exemplo em Node.js
var http = require("https");
var options = {
"method": "POST",
"hostname": "api.plugzapi.com.br",
"port": null,
"path": "/instances/SUA_INSTANCIA/token/SEU_TOKEN/send-option-list",
"headers": {}
};
var req = http.request(options, function (res) {
var chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
var body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
phone: '5511999998888',
message: 'Selecione e melhor opção:',
optionList: {
title: 'Opções disponíveis',
buttonLabel: 'Abrir lista de opções',
options: [
{
id: '1',
description: 'PlugMessage Mais software, menos esforço',
title: 'PlugMessage'
},
{id: '2', description: 'Não funcionam', title: 'Outros'}
]
}
}));
req.end();
Exemplo em C#
var client = new RestClient("https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/send-option-list");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddParameter("undefined", "{\"phone\": \"5511999998888\", \"message\": \"Selecione e melhor opção:\",\"optionList\": { \"title\": \"Opções disponíveis\", \"buttonLabel\": \"Abrir lista de opções\", \"options\": [ { \"id\": \"1\", \"description\": \"PlugMessage Mais software, menos esforço\", \"title\": \"PlugMessage\" }, { \"id\": \"2\", \"description\": \"Não funcionam\", \"title\": \"Outros\" } ] }}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Comentários
0 comentário
Por favor, entre para comentar.