Método
/security/verify-email
Tipo | URL |
POST |
https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/security/verify-email |
Header
Key | Value |
Client-Token | TOKEN DE SEGURANÇA DA CONTA |
Conceituação
Método utilizado para realizar verificação do e-mail da conta. Você pode cadastrar um e-mail na sua conta do WhatsApp através da API de Cadastrar e-mail na conta.
Atenção Essa API está disponível apenas para instâncias mobile.
Atributos
Obrigatórios;
Atributos |
Tipo |
Descrição |
verificationCode |
string |
Código de verificação enviado para o email que foi cadastrado na conta |
Request Body:
{
"verificationCode": "123456"
}
Response
200
Atributos |
Tipo |
Descrição |
success |
Boolean |
Define se a requisição foi executada com sucesso |
Exemplo:
400
Requisição inválida. Verifique se os dados que você está enviando estão de acordo com o documentado acima.
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 C#:
var client = new RestClient("https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/security/verify-email");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("client-token", "{{security-token}}");
request.AddParameter("undefined", "{\"verificationCode\": \"123456\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
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/security/verify-email",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\"verificationCode\": \"123456\"}",
CURLOPT_HTTPHEADER => array(
"client-token: {{security-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;
}
Exemplo em NodeJs:
var http = require("https");
var options = {
"method": "POST",
"hostname": "api.plugzapi.com.br",
"port": null,
"path": "/instances/SUA_INSTANCIA/token/SEU_TOKEN/security/verify-email",
"headers": {
"client-token": "{{security-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({verificationCode: '123456'}));
req.end();
Comentários
0 comentário
Por favor, entre para comentar.