Solicitar Código de Pareamento - Wappfy API

Solicitar código de autenticação.

curl --request POST \
  --url https://{host}/api/{session}/auth/request-code \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "phoneNumber": "12132132130",
  "method": null
}
'

import requests

url = "https://{host}/api/{session}/auth/request-code"

payload = {
    "phoneNumber": "12132132130",
    "method": None
}
headers = {
    "apikey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({phoneNumber: '12132132130', method: null})
};

fetch('https://{host}/api/{session}/auth/request-code', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/api/{session}/auth/request-code",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'phoneNumber' => '12132132130',
    'method' => null
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/api/{session}/auth/request-code"

	payload := strings.NewReader("{\n  \"phoneNumber\": \"12132132130\",\n  \"method\": null\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("apikey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/api/{session}/auth/request-code")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phoneNumber\": \"12132132130\",\n  \"method\": null\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/api/{session}/auth/request-code")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"phoneNumber\": \"12132132130\",\n  \"method\": null\n}"

response = http.request(request)
puts response.read_body

{
  "code": "ABCD-1234"
}

POST

api

{session}

auth

request-code

Solicitar código de autenticação.

curl --request POST \
  --url https://{host}/api/{session}/auth/request-code \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "phoneNumber": "12132132130",
  "method": null
}
'

import requests

url = "https://{host}/api/{session}/auth/request-code"

payload = {
    "phoneNumber": "12132132130",
    "method": None
}
headers = {
    "apikey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({phoneNumber: '12132132130', method: null})
};

fetch('https://{host}/api/{session}/auth/request-code', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/api/{session}/auth/request-code",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'phoneNumber' => '12132132130',
    'method' => null
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/api/{session}/auth/request-code"

	payload := strings.NewReader("{\n  \"phoneNumber\": \"12132132130\",\n  \"method\": null\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("apikey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/api/{session}/auth/request-code")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phoneNumber\": \"12132132130\",\n  \"method\": null\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/api/{session}/auth/request-code")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"phoneNumber\": \"12132132130\",\n  \"method\": null\n}"

response = http.request(request)
puts response.read_body

{
  "code": "ABCD-1234"
}

Descrição

Este endpoint permite solicitar um código de pareamento como método alternativo de autenticação, sem a necessidade de escanear o QR Code. O código recebido deve ser inserido no aplicativo WhatsApp para estabelecer a conexão.

Parâmetros de URL

session

string

required

ID único da sessão a ser autenticada

Body

{
  "phone": "5511999999999"
}

Parâmetros do Body

Propriedade	Tipo	Obrigatório	Descrição
`phone`	`string`	✅ Sim	Número de telefone para o qual o código de pareamento será solicitado

Resposta

code

string

required

Código de pareamento gerado. Este código deve ser inserido no aplicativo WhatsApp para completar a autenticação.

{
  "code": "ABCD-1234"
}

Códigos de Status

200 - Código gerado com sucesso
400 - Parâmetros inválidos (ex: número de telefone inválido)
401 - Não autorizado

Exemplo de Uso

curl -X POST https://api.wappfy.com.br/api/my-session/auth/request-code \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "5511999999999"
  }'

const session = 'my-session';
const response = await fetch(`https://api.wappfy.com.br/api/${session}/auth/request-code`, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    phone: '5511999999999'
  })
});
const data = await response.json();
console.log(data.code);

import requests

session = 'my-session'
response = requests.post(
    f'https://api.wappfy.com.br/api/{session}/auth/request-code',
    json={
        'phone': '5511999999999'
    }
)
data = response.json()
print(data['code'])

Authorizations

apikey

string

header

required

Sua chave de API do Wappfy (obtenha em dash.wappfy.com.br)

Path Parameters

session

string

required

O nome da sessão (instanceName) que você deseja autenticar

Body

application/json

phoneNumber

string

required

Mobile phone number in international format

Example:

"12132132130"

method

string

How would you like to receive the one time code for registration? |sms|voice. Leave empty for Web pairing.

Example:

null

Response

201 - undefined

Obter QR Code Iniciar Sessão

​Descrição

​Parâmetros de URL

​Body

​Parâmetros do Body

​Resposta

​Códigos de Status

​Exemplo de Uso

Authorizations

Path Parameters

Body

Response

Descrição

Parâmetros de URL

Body

Parâmetros do Body

Resposta

Códigos de Status

Exemplo de Uso