Ir al contenido

Convenciones ​

URL base y formato ​

Todas las rutas cuelgan de /api/v1 en la URL de tu API:

https://zappio.cloud/api/v1

El formato es JSON (Content-Type: application/json), salvo la subida de archivos (multipart/form-data) y la descarga de multimedia. Las rutas de esta documentación son relativas a esa base.

Respuestas ​

Las respuestas exitosas envuelven el recurso en data: { "data": { ... } } o { "data": [ ... ] }. Eliminar devuelve 204 sin cuerpo. Los errores usan la forma de Errores.

Ids ​

Los ids son cadenas opacas con un prefijo, de hasta 40 caracteres. Trátalas como texto que distingue mayúsculas.

PrefijoRecurso
ins_Instancia
msg_Mensaje
grp_Grupo
wh_Webhook
whd_Entrega de webhook
key_API key

Fechas ​

Las fechas son ISO 8601 (2026-01-31T14:05:09+00:00) y valen null hasta que ocurre el evento que las llena.

Teléfonos ​

Los números salen siempre como dígitos con código de país (5215500000000). Al enviar, puedes escribirlos con espacios, guiones, paréntesis y un + inicial; se ignoran.

Paginación ​

GET /messages y GET /webhooks/{webhook}/deliveries usan cursores, de los más recientes a los más antiguos. Pasa limit (1 a 100, 25 por defecto) y sigue meta.next_cursor como parámetro cursor hasta que valga null. No construyas cursores tú mismo.

GET /instances, GET /webhooks y GET /instances/{instance}/groups devuelven todo, sin paginar.