Conectar canal Meta WhatsApp
curl --request POST \
--url https://api.omni.z-api.io/v1/channels/{channelId}/connect \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"wabaId": "428083093730937",
"phoneId": "123456789012345",
"code": "ABC123DEF456",
"coexistence": false
}
'import requests
url = "https://api.omni.z-api.io/v1/channels/{channelId}/connect"
payload = {
"wabaId": "428083093730937",
"phoneId": "123456789012345",
"code": "ABC123DEF456",
"coexistence": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
wabaId: '428083093730937',
phoneId: '123456789012345',
code: 'ABC123DEF456',
coexistence: false
})
};
fetch('https://api.omni.z-api.io/v1/channels/{channelId}/connect', 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://api.omni.z-api.io/v1/channels/{channelId}/connect",
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([
'wabaId' => '428083093730937',
'phoneId' => '123456789012345',
'code' => 'ABC123DEF456',
'coexistence' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.omni.z-api.io/v1/channels/{channelId}/connect"
payload := strings.NewReader("{\n \"wabaId\": \"428083093730937\",\n \"phoneId\": \"123456789012345\",\n \"code\": \"ABC123DEF456\",\n \"coexistence\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.omni.z-api.io/v1/channels/{channelId}/connect")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"wabaId\": \"428083093730937\",\n \"phoneId\": \"123456789012345\",\n \"code\": \"ABC123DEF456\",\n \"coexistence\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omni.z-api.io/v1/channels/{channelId}/connect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"wabaId\": \"428083093730937\",\n \"phoneId\": \"123456789012345\",\n \"code\": \"ABC123DEF456\",\n \"coexistence\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"error": 401,
"message": "Unauthorized"
}Canais
Conectar canal Meta WhatsApp
Fluxo completo para conectar um canal META_WHATSAPP à API Oficial do WhatsApp
POST
/
v1
/
channels
/
{channelId}
/
connect
Conectar canal Meta WhatsApp
curl --request POST \
--url https://api.omni.z-api.io/v1/channels/{channelId}/connect \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"wabaId": "428083093730937",
"phoneId": "123456789012345",
"code": "ABC123DEF456",
"coexistence": false
}
'import requests
url = "https://api.omni.z-api.io/v1/channels/{channelId}/connect"
payload = {
"wabaId": "428083093730937",
"phoneId": "123456789012345",
"code": "ABC123DEF456",
"coexistence": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
wabaId: '428083093730937',
phoneId: '123456789012345',
code: 'ABC123DEF456',
coexistence: false
})
};
fetch('https://api.omni.z-api.io/v1/channels/{channelId}/connect', 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://api.omni.z-api.io/v1/channels/{channelId}/connect",
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([
'wabaId' => '428083093730937',
'phoneId' => '123456789012345',
'code' => 'ABC123DEF456',
'coexistence' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.omni.z-api.io/v1/channels/{channelId}/connect"
payload := strings.NewReader("{\n \"wabaId\": \"428083093730937\",\n \"phoneId\": \"123456789012345\",\n \"code\": \"ABC123DEF456\",\n \"coexistence\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.omni.z-api.io/v1/channels/{channelId}/connect")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"wabaId\": \"428083093730937\",\n \"phoneId\": \"123456789012345\",\n \"code\": \"ABC123DEF456\",\n \"coexistence\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omni.z-api.io/v1/channels/{channelId}/connect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"wabaId\": \"428083093730937\",\n \"phoneId\": \"123456789012345\",\n \"code\": \"ABC123DEF456\",\n \"coexistence\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"error": 401,
"message": "Unauthorized"
}Visão geral
Após criar um canal do tipoMETA_WHATSAPP, você precisa conectá-lo a um número do WhatsApp Business. Existem duas formas:
- Pelo painel — Fluxo guiado diretamente no Dashboard
- Via SDK + API — Integre o fluxo de conexão no seu sistema
Conexão pelo painel
A forma mais simples. Acesse o Dashboard, selecione o canal criado e siga o fluxo de conexão guiado.Conexão via SDK + API
Use este fluxo quando quiser que o seu usuário conecte o canal de dentro do seu sistema, sem precisar acessar o painel do . O fluxo tem 3 etapas:1
Frontend — Iniciar conexão com o SDK
No frontend da sua aplicação, use o SDK para iniciar o fluxo de conexão. O SDK vai abrir o processo de autenticação com o WhatsApp e retornar as informações necessárias.
import OmniZapi from '@omni-zapi/connect';
const client = OmniZapi.newClient({
publicKey: 'SUA_PUBLIC_KEY'
});
const response = await client.connect({
channelId: 'ID_DO_CANAL'
});
// Envie o response para o seu backend
A
publicKey pode ser exposta no frontend. Veja mais em Autenticação.2
Frontend → Backend — Enviar dados
O SDK retorna um objeto com as informações da conexão. Envie esses dados para o backend da sua aplicação:
{
"wabaId": "428083093730937",
"phoneId": "123456789012345",
"code": "ABC123DEF456",
"coexistence": false
}
| Campo | Tipo | Descrição |
|---|---|---|
wabaId | string | ID do WhatsApp Business Account selecionado |
phoneId | string | ID do número de telefone selecionado |
code | string | Código de autorização gerado pelo WhatsApp |
coexistence | boolean | Se o número está em modo de coexistência |
3
Backend — Finalizar conexão via API
No backend, chame a API de conexão passando os dados recebidos do frontend:
POST /v1/channels/{channelId}/connectcurl -X POST https://api.omni.z-api.io/v1/channels/ID_DO_CANAL/connect \
-H "Content-Type: application/json" \
-H "Authorization: Bearer SUA_SECRET_KEY" \
-d '{
"wabaId": "428083093730937",
"phoneId": "123456789012345",
"code": "ABC123DEF456",
"coexistence": false
}'
Esta chamada deve ser feita no backend, pois utiliza a Secret Key que nunca deve ser exposta no frontend.
Fluxo resumido
Frontend (SDK) → Backend (API)
1. client.connect()
2. Usuário autentica
3. SDK retorna dados ----→ 4. POST /v1/channels/{id}/connect
com wabaId, phoneId, code, coexistence
5. Canal conectado ✓
Após a conexão, o canal está pronto para enviar e receber mensagens. Use o
channelId nos endpoints de mensagens livres e templates.Autorizações
Secret Key gerada no painel de Segurança do Omni Z-API
Parâmetros de caminho
ID do canal (obtido via Criar canal)
Exemplo:
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
Corpo
application/json
Resposta
Canal conectado com sucesso
Indica se a operação foi realizada com sucesso