Saltar para o conteúdo principal
GET
/
public
/
api
/
v1
/
channel-types
/
{channelType}
Get channel type
curl --request GET \
  --url https://api.gennia.ai/public/api/v1/channel-types/{channelType} \
  --header 'X-Api-Key: <api-key>'
{
  "configSchema": {},
  "credentialsSchema": {},
  "description": "<string>",
  "label": "WhatsApp via Z-API",
  "supports": {
    "configuration": true,
    "credentials": true,
    "instanceMode": true,
    "test": true
  }
}

Autorizações

​
X-Api-Key
string
header
obrigatório

Parâmetros de caminho

​
channelType
enum<string>
obrigatório

Channel type key.

Opções disponíveis:
whatsapp,
z_api,
web_chat

Resposta

OK

Channel type metadata + JSON Schemas for config/credentials.

​
configSchema
object

JSON Schema for the channelSpecificConfig field (null if not supported).

​
credentialsSchema
object

JSON Schema for the credentials field (null if not supported).

​
description
string

Free-form description of the channel surface.

​
label
string

Human-readable label.

Exemplo:

"WhatsApp via Z-API"

​
supports
object

Capability matrix for this channel type.

​
type
enum<string>

Channel type key.

Opções disponíveis:
whatsapp,
z_api,
web_chat