Exemplo Rápido
Uma forma simples de testar o envio de uma mensagem:
https://pro-apiv2.plwdesign.online/webservice/api?name=SUA_INSTANCIA&number=5541988150812&message=ola%20mundo
Enviar Mensagem de Texto
Método: GET
Parâmetros:
name
(obrigatório): Seu nome de instância.number
(obrigatório): Número do destinatário no formato internacional.message
(obrigatório): Conteúdo da mensagem.type
(opcional, padrão:text
): Tipo da mensagem.
Exemplo em PHP (cURL):
<?php
$token = "SEU_TOKEN_AQUI"; // Substitua pelo seu token ou nome da instância
$numero = "5541988150812";
$mensagem = "Olá mundo via API!";
$url = "https://pro-apiv2.plwdesign.online/webservice/api?" . http_build_query([
'name' => $token,
'number' => $numero,
'message' => $mensagem,
'type' => 'text'
]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); // Apenas para desenvolvimento, remova em produção se o SSL for válido
$response = curl_exec($ch);
curl_close($ch);
echo $response;
?>
Enviar Mensagem com Mídia
Método: GET
Parâmetros:
name
(obrigatório): Seu nome de instância.number
(obrigatório): Número do destinatário.type
(obrigatório): Deve sermedia
.media
(obrigatório): URL pública da imagem/mídia.message
(opcional): Legenda para a mídia.
Exemplo em PHP (cURL):
<?php
$token = "SUA_INSTANCIA";
$numero = "5541988150812";
$urlMedia = "https://www.example.com/imagem.jpg"; // URL pública da sua imagem
$legenda = "Olha essa imagem!";
$url = "https://pro-apiv2.plwdesign.online/webservice/api?" . http_build_query([
'name' => $token,
'number' => $numero,
'type' => 'media',
'media' => $urlMedia,
'message' => $legenda
]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
?>
Respostas da API (JSON)
A API retornará respostas no formato JSON.
Sucesso:
{
"success": true,
"message": "Mensagem enviada com sucesso"
}
Erro:
{
"error": "Mensagem de erro detalhada aqui"
}
Códigos de Status HTTP
A API utiliza os seguintes códigos de status HTTP:
200 OK
- Requisição bem-sucedida.400 Bad Request
- Parâmetros inválidos ou ausentes na requisição. Verifique a mensagem de erro no corpo da resposta.401 Unauthorized
- Token/Nome da instância inválido ou não fornecido.403 Forbidden
- Acesso negado, talvez a instância não esteja ativa ou não tenha permissão.500 Internal Server Error
- Ocorreu um erro inesperado no servidor.
Observações Importantes
- O parâmetro
number
deve ser fornecido no formato internacional completo (código do país + DDD + número). Exemplo para Brasil:5511999999999
. - Para números brasileiros, se o DDI
55
não for incluído, o sistema tentará adicioná-lo automaticamente. No entanto, é recomendado sempre enviar o formato completo para evitar ambiguidades. - O Token ID (ou nome da instância, referenciado como
name
nos exemplos) pode ser encontrado na sua página de conexões dentro da plataforma Pro-API ChatBot. - Para que o envio de mensagens funcione, a sua instância correspondente ao
name
fornecido deve estar ativa e conectada ao WhatsApp. - URLs de mídia devem ser publicamente acessíveis.