Bem-vindo(a) ao Suporte da Tecnospeed

Em que podemos ajudar? :)

Artigos nessa seção

Exibir mais

Enviar documentos

Avatar
Bruno Caldeef
  • Atualizado
Seguir

 

Método responsável por enviar documentos aos seus contatos é simples e objetivo.

 

Tamanho e formatos

O Whatsapp limita o tamanho de arquivos e sua política muda constantemente, por isso sempre recomendamos a verificação direto no site do próprio Whatsapp.

Neste link você encontra tudo que precisa saber sobre formatos e tamanhos de arquivos.

 

/send-document/{extension}

Tipo URL
POST https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/send-document/{extension}

 

Atributos

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
document string Link do documento ou seu Base64

 

Opcionais

Atributos Tipo Descrição
fileName String Nome do documento
messageId String Atributo utilizado para responder uma mensagem do chat, basta adicionar o messageId da mensagem que queira responder neste atributo
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

 

Request Body:

 

Exemplo URL

{
"phone":"5544999999999",
"document":"https://expoforest.com.br/wp-content/uploads/2017/05/exemplo.pdf",
"fileName":"Meu PDF"
}
 

Exemplo Base64

 {
  "phone":"5544999999999",
  "document": "data:application/pdf;base64, {{Código encode do PDF}}"
  "fileName":"Meu PDF"
 }

 

 

Response

200

Atributos Tipo Descrição
zaapId string id no PlugMessage
messageId string id no whatsapp

Exemplo: 

{
"zaapId":"3999984263738042930CD6ECDE9VDWSA",
"messageId":"D241XXXX732339502B68"
}

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

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/send-document/pdf",
  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\", \"video\": \"http://techslides.com/demos/sample-videos/small.mp4s\"}",
  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-document/pdf",
  "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',
  video: 'http://techslides.com/demos/sample-videos/small.mp4s'
}));
req.end();

 

/send-link

Tipo URL
POST https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/send-link

 

Atributos

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 sobre seu link.

Não esqueça de informar o mesmo valor do link URL no final deste texto.
image string Link da imagem
linkUrl string Url do seu link
title string Título para o link
linkDescription string descrição do link

 

Opcionais

Atributos Tipo Descrição
messageId String Atributo utilizado para responder uma mensagem do chat, basta adicionar o messageId da mensagem que queira responder neste atributo
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
linkType String Atributo utilizado para definir o tamanho da mensagem de visualização do link enviado (SMALL, MEDIUM ou LARGE). O tamanho default caso não seja informado é SMALL.

 

Request Body:

{
"phone":"5511999998888",
"message":"Aqui você coloca um texto sobre o site, atenção esse texto preciso ter o link que será enviado no final da mensagem! Assim: https://plugzapi.com.br",
"image":"https://firebasestorage.googleapis.com/v0/b/zaap-messenger-web.appspot.com/o/logo.png?alt=media",
"linkUrl":"https://plugzapi.com.br",
"title":"PlugMessage",
"linkDescription":"Integração com o whatsapp"
}

 

Response

200

Atributos Tipo Descrição
zaapId string id no PlugMessage
messageId string

id no whatsapp

 

Exemplo: 

{
"zaapId":"3999984263738042930CD6ECDE9VDWSA",
"messageId":"D241XXXX732339502B68"
}

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-link",
 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\": \"Aqui você coloca um texto sobre o site, atenção esse texto preciso ter o link que será enviado no final da mensagem! Assim: https://plugzapi.com.br\",\"image\": \"https://firebasestorage.googleapis.com/v0/b/zaap-messenger-web.appspot.com/o/logo.png?alt=media\",\"linkUrl\": \"https://plugzapi.com.br\",\"title\": \"PlugMessage\",\"linkDescription\": \"Integração com o whatsapp\"}",
 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-link",
"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: 'Aqui você coloca um texto sobre o site, atenção esse texto preciso ter o link que será enviado no final da mensagem! Assim: https://plugzapi.com.br',
image: 'https://firebasestorage.googleapis.com/v0/b/zaap-messenger-web.appspot.com/o/logo.png?alt=media',
linkUrl: 'https://plugzapi.com.br',
title: 'PlugMessage',
linkDescription: 'Integração com o whatsapp'
}));
req.end();

Exemplo em C#

var client = new RestClient("https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/send-link");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddParameter("undefined", "{\"phone\": \"5511999998888\",\"message\": \"Aqui você coloca um texto sobre o site, atenção esse texto preciso ter o link que será enviado no final da mensagem! Assim: https://plugzapi.com.br\",\"image\": \"https://firebasestorage.googleapis.com/v0/b/zaap-messenger-web.appspot.com/o/logo.png?alt=media\",\"linkUrl\": \"https://plugzapi.com.br\",\"title\": \"PlugMessage\",\"linkDescription\": \"Integração com o whatsapp\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
 

Artigos relacionados

Comentários

0 comentário

Por favor, entre para comentar.

Ícone de Chat