ZapyFlow/Documentación de la APIopenapi.json

Channels

Canales de WhatsApp

GET/api/channels

Ámbito requerido: channels.read

ParámetroDóndeObligatorio
searchqueryno
includeDeactivatedqueryno
bash
curl "https://api.zapyflow.com.br/api/channels" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK

POST/api/channels

Ámbito requerido: channels.write

Cuerpo de la petición

CampoTipoObligatorioRestricciones
namestringsímin 2, max 120
provider"BAILEYS" | "CLOUD_API"sí—
bash
curl -X POST "https://api.zapyflow.com.br/api/channels" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'
Respuestas
  • 201 — Creado
  • 403 — Prohibido, o la clave no tiene este ámbito

GET/api/channels/{id}

Ámbito requerido: channels.read

ParámetroDóndeObligatorio
idpathsí
bash
curl "https://api.zapyflow.com.br/api/channels/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK
  • 404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

PATCH/api/channels/{id}

Ámbito requerido: channels.write

ParámetroDóndeObligatorio
idpathsí

Cuerpo de la petición

CampoTipoObligatorioRestricciones
namestringsí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 '{ ... }'
Respuestas
  • 200 — OK

PUT/api/channels/{id}/ai-agent

Ámbito requerido: channels.write

ParámetroDóndeObligatorio
idpathsí

Cuerpo de la petición

CampoTipoObligatorioRestricciones
aiAgentIdstringsí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 '{ ... }'
Respuestas
  • 200 — OK
  • 404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

DELETE/api/channels/{id}/ai-agent

Ámbito requerido: channels.write

ParámetroDóndeObligatorio
idpathsí
bash
curl -X DELETE "https://api.zapyflow.com.br/api/channels/{id}/ai-agent" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK

GET/api/channels/{id}/business-verification

Ámbito requerido: channels.read

ParámetroDóndeObligatorio
idpathsí
bash
curl "https://api.zapyflow.com.br/api/channels/{id}/business-verification" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK

POST/api/channels/{id}/deactivate

Ámbito requerido: channels.write

ParámetroDóndeObligatorio
idpathsí
bash
curl -X POST "https://api.zapyflow.com.br/api/channels/{id}/deactivate" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK

GET/api/channels/{id}/health

Ámbito requerido: channels.read

ParámetroDóndeObligatorio
idpathsí
bash
curl "https://api.zapyflow.com.br/api/channels/{id}/health" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK

GET/api/channels/{id}/meta/templates

Ámbito requerido: channels.read

ParámetroDóndeObligatorio
idpathsí
bash
curl "https://api.zapyflow.com.br/api/channels/{id}/meta/templates" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK
  • 400 — Petición malformada
  • 404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace
  • 502 — Falla del proveedor externo

GET/api/channels/{id}/qr

Ámbito requerido: channels.read

ParámetroDóndeObligatorio
refreshqueryno
idpathsí
bash
curl "https://api.zapyflow.com.br/api/channels/{id}/qr" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK

POST/api/channels/{id}/reactivate

Ámbito requerido: channels.write

ParámetroDóndeObligatorio
idpathsí
bash
curl -X POST "https://api.zapyflow.com.br/api/channels/{id}/reactivate" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK