For the complete documentation index, see llms.txt. This page is also available as Markdown.

🔌 Canais E Sessões

CreateSession

post
Autorizações
AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota
apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo
namestringOpcional

Nome da instância do WhatsApp

Example: My WhatsApp Instance
statusstringOpcional

Status inicial da sessão (DISCONNECTED, CONNECTED)

Example: DISCONNECTED
typestringOpcional

Tipo da sessão

Example: baileys
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
post/v2/api/external/{apiId}/createtSession
POST /v2/api/external/{apiId}/createtSession HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "name": "My WhatsApp Instance",
  "status": "DISCONNECTED",
  "type": "baileys"
}
{}

DeleteSession

post
Autorizações
AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota
apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo
whatsappIdintegerOpcional

ID da sessão do WhatsApp que será deletada

Example: 1
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
post/v2/api/external/{apiId}/deleteSession
POST /v2/api/external/{apiId}/deleteSession HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "whatsappId": 1
}
{}

RequestNewQrCode

post
Autorizações
AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota
apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo
whatsappIdintegerOpcional

ID da sessão do WhatsApp que terá um novo QR Code gerado

Example: 1
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
post/v2/api/external/{apiId}/requestNewQrCodeSession
POST /v2/api/external/{apiId}/requestNewQrCodeSession HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "whatsappId": 1
}
{}

ShowChannelInformation

post
Autorizações
AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota
apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo
numberstringOpcional

Número do WhatsApp do canal (formato: 5511999999999)

Example: 5515998566622
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
post/v2/api/external/{apiId}/showChannel
POST /v2/api/external/{apiId}/showChannel HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "number": "5515998566622"
}
{}

ShowChannelInformationById

post
Autorizações
AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota
apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo
idintegerOpcional

ID do canal que será consultado

Example: 43
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
post/v2/api/external/{apiId}/showChannelById
POST /v2/api/external/{apiId}/showChannelById HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 9

{
  "id": 43
}
{}

ShowQrCode

post
Autorizações
AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota
apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo
whatsappIdintegerOpcional

ID da sessão do WhatsApp que terá o QR Code gerado

Example: 1
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
post/v2/api/external/{apiId}/qrCodeSession
POST /v2/api/external/{apiId}/qrCodeSession HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "whatsappId": 1
}
{}

StartSession

post
Autorizações
AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota
apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo
whatsappIdintegerOpcional

ID da sessão do WhatsApp que será iniciada

Example: 1
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
post/v2/api/external/{apiId}/startSession
POST /v2/api/external/{apiId}/startSession HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "whatsappId": 1
}
{}

Atualizado

Isto foi útil?