Iniciar Sessão - Wappfy API

Iniciar a sessão

curl --request POST \
  --url https://{host}/api/sessions/{session}/start \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '{}'

import requests

url = "https://{host}/api/sessions/{session}/start"

payload = {}
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({})
};

fetch('https://{host}/api/sessions/{session}/start', 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/sessions/{session}/start",
  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([
    
  ]),
  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/sessions/{session}/start"

	payload := strings.NewReader("{}")

	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/sessions/{session}/start")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/api/sessions/{session}/start")

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 = "{}"

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

{
  "success": true,
  "message": "Sessão iniciada com sucesso",
  "session": "my-session"
}

POST

api

sessions

{session}

start

Iniciar a sessão

curl --request POST \
  --url https://{host}/api/sessions/{session}/start \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '{}'

import requests

url = "https://{host}/api/sessions/{session}/start"

payload = {}
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({})
};

fetch('https://{host}/api/sessions/{session}/start', 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/sessions/{session}/start",
  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([
    
  ]),
  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/sessions/{session}/start"

	payload := strings.NewReader("{}")

	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/sessions/{session}/start")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/api/sessions/{session}/start")

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 = "{}"

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

{
  "success": true,
  "message": "Sessão iniciada com sucesso",
  "session": "my-session"
}

Descrição

Este endpoint inicializa uma nova sessão do WhatsApp. Após iniciar a sessão, você precisará autenticá-la usando o QR Code ou código de pareamento. É possível fornecer configurações personalizadas para o armazenamento e logs da sessão.

Parâmetros de URL

session

string

required

ID único da sessão a ser iniciada

Body

{
  "config": {
    "store": {
      "dialect": "sqlite3",
      "address": "/app/data/whatsmeow.db"
    },
    "log": {
      "level": "INFO"
    }
  }
}

Parâmetros do Body

Propriedade	Tipo	Obrigatório	Descrição
`config`	`object`	❌ Não	Configurações opcionais para a sessão
`config.store`	`object`	❌ Não	Configurações de armazenamento da sessão
`config.store.dialect`	`string`	❌ Não	Tipo de banco de dados (padrão: “sqlite3”)
`config.store.address`	`string`	❌ Não	Caminho do arquivo do banco de dados (padrão: “/app/data/whatsmeow.db”)
`config.log`	`object`	❌ Não	Configurações de log da sessão
`config.log.level`	`string`	❌ Não	Nível de log: “DEBUG”, “INFO”, “WARN”, “ERROR” (padrão: “INFO”)

{
  "success": true,
  "message": "Sessão iniciada com sucesso",
  "session": "my-session"
}

Códigos de Status

200 - Sessão iniciada com sucesso
400 - Parâmetros inválidos
409 - Sessão já existe e está ativa

Exemplo de Uso

curl -X POST https://api.wappfy.com.br/api/sessions/my-session/start \
  -H "Content-Type: application/json" \
  -d '{
    "config": {
      "store": {
        "dialect": "sqlite3",
        "address": "/app/data/whatsmeow.db"
      },
      "log": {
        "level": "INFO"
      }
    }
  }'

const session = 'my-session';
const response = await fetch(`https://api.wappfy.com.br/api/sessions/${session}/start`, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    config: {
      store: {
        dialect: 'sqlite3',
        address: '/app/data/whatsmeow.db'
      },
      log: {
        level: 'INFO'
      }
    }
  })
});
const data = await response.json();
console.log(data);

import requests

session = 'my-session'
response = requests.post(
    f'https://api.wappfy.com.br/api/sessions/{session}/start',
    json={
        'config': {
            'store': {
                'dialect': 'sqlite3',
                'address': '/app/data/whatsmeow.db'
            },
            'log': {
                'level': 'INFO'
            }
        }
    }
)
data = response.json()
print(data)

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 iniciar

Body

application/json

The body is of type object.

Response

201 - application/json

name

string

required

Nome da sessão (instanceName)

Example:

"my-session"

status

enum<string>

required

Available options:

STOPPED,

STARTING,

SCAN_QR_CODE,

WORKING,

FAILED

config

object

Show child attributes

Solicitar Código de Pareamento Obter Sessão

​Descrição

​Parâmetros de URL

​Body

​Parâmetros do Body

​Códigos de Status

​Exemplo de Uso

Authorizations

Path Parameters

Body

Response

Descrição

Parâmetros de URL

Body

Parâmetros do Body

Códigos de Status

Exemplo de Uso