Channels
Canais de WhatsApp
GET/api/channels
Escopo exigido: channels.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
search | query | não |
includeDeactivated | query | não |
bash
curl "https://api.zapyflow.com.br/api/channels" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK
POST/api/channels
Escopo exigido: channels.write
Corpo da requisição
| Campo | Tipo | Obrigatório | Restrições |
|---|---|---|---|
name | string | sim | min 2, max 120 |
provider | "BAILEYS" | "CLOUD_API" | sim | — |
bash
curl -X POST "https://api.zapyflow.com.br/api/channels" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respostas
201— Criado403— Proibido, ou a chave não tem este escopo
GET/api/channels/{id}
Escopo exigido: channels.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl "https://api.zapyflow.com.br/api/channels/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace
PATCH/api/channels/{id}
Escopo exigido: channels.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
Corpo da requisição
| Campo | Tipo | Obrigatório | Restrições |
|---|---|---|---|
name | string | sim | min 2, max 120 |
bash
curl -X PATCH "https://api.zapyflow.com.br/api/channels/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respostas
200— OK
PUT/api/channels/{id}/ai-agent
Escopo exigido: channels.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
Corpo da requisição
| Campo | Tipo | Obrigatório | Restrições |
|---|---|---|---|
aiAgentId | string | sim | min 1 |
bash
curl -X PUT "https://api.zapyflow.com.br/api/channels/{id}/ai-agent" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace
DELETE/api/channels/{id}/ai-agent
Escopo exigido: channels.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl -X DELETE "https://api.zapyflow.com.br/api/channels/{id}/ai-agent" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK
GET/api/channels/{id}/business-verification
Escopo exigido: channels.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl "https://api.zapyflow.com.br/api/channels/{id}/business-verification" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK
POST/api/channels/{id}/deactivate
Escopo exigido: channels.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl -X POST "https://api.zapyflow.com.br/api/channels/{id}/deactivate" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK
GET/api/channels/{id}/health
Escopo exigido: channels.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl "https://api.zapyflow.com.br/api/channels/{id}/health" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK
GET/api/channels/{id}/meta/templates
Escopo exigido: channels.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl "https://api.zapyflow.com.br/api/channels/{id}/meta/templates" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK400— Requisição malformada404— Não encontrado — também é a resposta quando o recurso é de outro workspace502— Falha do provedor externo
GET/api/channels/{id}/qr
Escopo exigido: channels.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
refresh | query | não |
id | path | sim |
bash
curl "https://api.zapyflow.com.br/api/channels/{id}/qr" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK
POST/api/channels/{id}/reactivate
Escopo exigido: channels.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl -X POST "https://api.zapyflow.com.br/api/channels/{id}/reactivate" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK