Consultar canal (Socio)
curl --request GET \
--url https://api.omni.z-api.io/v1/channels/{channelId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.omni.z-api.io/v1/channels/{channelId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.omni.z-api.io/v1/channels/{channelId}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.omni.z-api.io/v1/channels/{channelId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.omni.z-api.io/v1/channels/{channelId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omni.z-api.io/v1/channels/{channelId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "AA0C61D24A6549A3BF83239847DE1CC2",
"name": "Suporte",
"token": "F1B29C3D4E5A6B7C8D9E0F1A2B3C4D5E",
"tenant": "01A090B7FB82798CB38AB259C0B65FBE",
"type": "META_WHATSAPP",
"created": "2026-03-11T14:02:00.000Z",
"due": 1774915200000,
"paymentStatus": "PAID",
"phoneConnected": true,
"whatsappConnected": true,
"phoneNumberConnected": "5585999999999",
"businessId": "102938475610293",
"whatsappCoexistence": false,
"webhooks": [
{
"id": "01A08132F180733B83D7B7BDFAF9E574",
"url": "https://parceiro.example.com/hook",
"events": [
"MESSAGE_RECEIVED",
"MESSAGE_DELIVERY"
]
}
]
}{
"error": "Authorization invalid"
}{
"error": "Channel not found"
}{
"error": "Channel listing requires ENTERPRISE role"
}Canales
Consultar canal
Consulta los datos de un canal por su identificador
GET
/
v1
/
channels
/
{channelId}
Consultar canal (Socio)
curl --request GET \
--url https://api.omni.z-api.io/v1/channels/{channelId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.omni.z-api.io/v1/channels/{channelId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.omni.z-api.io/v1/channels/{channelId}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.omni.z-api.io/v1/channels/{channelId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.omni.z-api.io/v1/channels/{channelId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omni.z-api.io/v1/channels/{channelId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "AA0C61D24A6549A3BF83239847DE1CC2",
"name": "Suporte",
"token": "F1B29C3D4E5A6B7C8D9E0F1A2B3C4D5E",
"tenant": "01A090B7FB82798CB38AB259C0B65FBE",
"type": "META_WHATSAPP",
"created": "2026-03-11T14:02:00.000Z",
"due": 1774915200000,
"paymentStatus": "PAID",
"phoneConnected": true,
"whatsappConnected": true,
"phoneNumberConnected": "5585999999999",
"businessId": "102938475610293",
"whatsappCoexistence": false,
"webhooks": [
{
"id": "01A08132F180733B83D7B7BDFAF9E574",
"url": "https://parceiro.example.com/hook",
"events": [
"MESSAGE_RECEIVED",
"MESSAGE_DELIVERY"
]
}
]
}{
"error": "Authorization invalid"
}{
"error": "Channel not found"
}{
"error": "Channel listing requires ENTERPRISE role"
}Conceptos
Devuelve un canal del workspace de tu Secret Key, con los mismos campos del listado más los webhooks registrados en él: id, URL y eventos de cada endpoint.Un canal de otro workspace responde
404, igual que un canal inexistente. La respuesta no distingue entre los dos casos a propósito.Webhooks
A diferencia de Z-API, donde cada instancia tiene una URL fija por tipo de callback, en Omni un canal puede tener varios endpoints, cada uno suscrito a los eventos que elijas. Para crearlos, editarlos o eliminarlos, usa las rutas de webhooks del canal.El
channelId se obtiene mediante el endpoint Crear canal o Listar canales.Autorizaciones
Secret Key generada en el panel de Seguridad de Omni Z-API
Parámetros de ruta
Identificador del canal
Ejemplo:
"AA0C61D24A6549A3BF83239847DE1CC2"
Respuesta
Canal encontrado
Ejemplo:
"AA0C61D24A6549A3BF83239847DE1CC2"
Ejemplo:
"Suporte"
Ejemplo:
"F1B29C3D4E5A6B7C8D9E0F1A2B3C4D5E"
Ejemplo:
"01A090B7FB82798CB38AB259C0B65FBE"
Opciones disponibles:
META_WHATSAPP, Z_API_WHATSAPP, META_INSTAGRAM, META_MESSENGER, BOT_TELEGRAM Ejemplo:
"META_WHATSAPP"
Ejemplo:
"2026-03-11T14:02:00.000Z"
Ejemplo:
1774915200000
Opciones disponibles:
PAID, PENDING, BOLETO_PENDING, CANCELLATION_PROCESS, CANCELED, TRIAL Ejemplo:
"PAID"
Ejemplo:
true
Ejemplo:
true
Ejemplo:
"5585999999999"
Ejemplo:
"102938475610293"
Ejemplo:
false
Show child attributes
Show child attributes