Método
/send-option-list
POST
https://www.speedchat.dev.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á disponível 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 botão 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 speedchat |
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"
Code
Exemplo:
C#
var client = new RestClient("https://www.speedchat.dev.br/api/whatsapp/send-option-list");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "TOKEN");
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\": \"Descrição dos botões\", \"title\": \"SpeedChat\" }, { \"id\": \"2\", \"description\": \"Sim\", \"title\": \"Não\" } ] }}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://www.speedchat.br/api/whatsapp/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\": \"Descrição dos botões\", \"title\": \"SpeedChat\" }, { \"id\": \"2\", \"description\": \"Sim\", \"title\": \"Não\" } ] }}",
CURLOPT_HTTPHEADER => array(
"authorization: TOKEN",
"content-type: application/json"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Node.js
var http = require("https");
var options = {
"method": "POST",
"hostname": "www.speedchat.dev.br",
"port": null,
"path": "/api/whatsapp/send-option-list",
"headers": {
"authorization": "TOKEN"
}
};
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: 'Descrição dos botões', title: 'SpeedChat'},
{id: '2', description: 'Sim', title: 'Não'}
]
}
}));
req.end();
Comentários
0 comentário
Por favor, entre para comentar.