Referencia de la API
Referencia de la API de WhatsApp por endpoint
Cada endpoint de la API REST de ZapZap en su propia página, con método, ruta, parámetros, ejemplos de solicitud en curl, Node.js y Python y una respuesta de ejemplo. 153 endpoints en 17 categorías.
Autenticación
Toda solicitud usa los encabezados x-api-key y x-api-secret, disponibles en el panel en Configuración y API.
Base URL
Las operaciones de una instancia usan /api/v1/{instanceId}/...; la gestión de cuenta e instancias usa /api/v1/instances, /api/v1/account y similares.
Las rutas son relativas a https://api.zapzapapi.com/api/v1. Reemplaza {instanceId} por el ID de la instancia que muestra el panel.
Cuenta e Instancias
- GET/accountDatos de la Cuenta
- GET/instancesListar Instancias
- POST/instancesCrear Instancia
- GET/instances/costCosto de Creación
- DELETE/instances/{id}Eliminar Instancia
- GET/instances/{id}Detalles de la Instancia
- PUT/instances/{id}Actualizar Instancia
- GET/instances/{id}/qrcodeCódigo QR de la Instancia
- GET/instances/{id}/webhookVer Webhook
- PUT/instances/{id}/webhookConfigurar Webhook
- POST/instances/{id}/webhook/testProbar Webhook
- GET/{instanceId}/instance/wa_messages_limitsLímites de Nuevas Conversaciones (WhatsApp)
Enviar Mensajes
- POST/{instanceId}/send/carouselEnviar Carrusel
- POST/{instanceId}/send/contactEnviar Contacto (vCard)
- POST/{instanceId}/send/locationEnviar Ubicación
- POST/{instanceId}/send/location-buttonSolicitar Ubicación
- POST/{instanceId}/send/mediaEnviar Multimedia
- POST/{instanceId}/send/buttonsEnviar Botones de Respuesta
- POST/{instanceId}/send/listEnviar Lista de Opciones
- POST/{instanceId}/send/pollEnviar Encuesta
- POST/{instanceId}/send/pix-buttonEnviar Botón PIX
- POST/{instanceId}/send/request-paymentSolicitar Pago
- POST/{instanceId}/send/statusEnviar Estado / Story
- POST/{instanceId}/send/textEnviar Texto
Conversaciones
- POST/{instanceId}/chat/archiveArchivar Chat
- POST/{instanceId}/chat/blockBloquear / Desbloquear Contacto
- GET/{instanceId}/chat/blocklistLista de Bloqueados
- POST/{instanceId}/chat/deleteEliminar Chat
- POST/{instanceId}/chat/findBuscar Chats
- POST/{instanceId}/chat/muteSilenciar Chat
- POST/{instanceId}/chat/notesVer Notas del Chat
- POST/{instanceId}/chat/notes/editEditar Notas del Chat
- POST/{instanceId}/chat/notes/refreshRecargar Notas
- POST/{instanceId}/chat/pinFijar / Desfijar Chat
- POST/{instanceId}/chat/readMarcar Chat como Leído
- POST/{instanceId}/message/deleteEliminar Mensaje
- POST/{instanceId}/message/downloadDescargar Multimedia
- POST/{instanceId}/message/editEditar Mensaje
- POST/{instanceId}/message/findHistorial de Mensajes
- POST/{instanceId}/message/history-syncSincronizar Historial
- POST/{instanceId}/message/markreadMarcar como Leído
- POST/{instanceId}/message/presenceIndicador de Escribiendo...
- POST/{instanceId}/message/reactReaccionar con Emoji
- POST/{instanceId}/chat/ephemeralMensajes Temporales (conversación privada)
Contactos y Perfil
- POST/{instanceId}/chat/checkVerificar Número
- POST/{instanceId}/chat/detailsDetalles del Contacto
- POST/{instanceId}/contact/addAgregar Contacto
- POST/{instanceId}/contact/removeEliminar Contacto
- GET/{instanceId}/contactsListar Contactos (Rápido)
- POST/{instanceId}/contacts/listListar Contactos
- POST/{instanceId}/profile/imageCambiar Foto
- POST/{instanceId}/profile/nameCambiar Nombre
Grupos
- POST/{instanceId}/community/createCrear comunidad
- POST/{instanceId}/community/editgroupsGestionar grupos de la comunidad
- POST/{instanceId}/group/createCrear grupo
- POST/{instanceId}/group/infoInformación del grupo
- POST/{instanceId}/group/inviteInfoInformación por invitación
- POST/{instanceId}/group/joinUnirse a un grupo por enlace
- POST/{instanceId}/group/leaveSalir del grupo
- GET/{instanceId}/group/listListar grupos
- POST/{instanceId}/group/listBuscar grupos
- POST/{instanceId}/group/resetInviteCodeRestablecer código de invitación
- POST/{instanceId}/group/updateAnnounceModo solo administradores
- POST/{instanceId}/group/updateDescriptionCambiar descripción del grupo
- POST/{instanceId}/group/updateImageCambiar foto del grupo
- POST/{instanceId}/group/updateLockedBloquear edición del grupo
- POST/{instanceId}/group/updateNameRenombrar grupo
- POST/{instanceId}/group/updateParticipantsGestionar participantes
- POST/{instanceId}/group/ephemeralMensajes temporales (grupo)
- POST/{instanceId}/group/updateJoinApprovalExigir aprobación para unirse
- POST/{instanceId}/group/updateMemberAddModeQuién puede agregar miembros
Newsletters y Canales
- POST/{instanceId}/newsletter/admin/acceptAceptar invitación de administrador
- POST/{instanceId}/newsletter/admin/inviteInvitar administrador del canal
- POST/{instanceId}/newsletter/admin/removeEliminar administrador del canal
- POST/{instanceId}/newsletter/admin/revokeRevocar invitación de administrador
- POST/{instanceId}/newsletter/createCrear canal
- POST/{instanceId}/newsletter/deleteEliminar canal
- POST/{instanceId}/newsletter/descriptionCambiar descripción del canal
- POST/{instanceId}/newsletter/followSeguir canal
- POST/{instanceId}/newsletter/infoInformación del canal
- POST/{instanceId}/newsletter/linkBuscar canal por enlace
- GET/{instanceId}/newsletter/listListar canales
- POST/{instanceId}/newsletter/messagesMensajes del canal
- POST/{instanceId}/newsletter/messages/deleteEliminar mensaje del canal
- POST/{instanceId}/newsletter/messages/editEditar mensaje del canal
- POST/{instanceId}/newsletter/muteSilenciar canal
- POST/{instanceId}/newsletter/nameCambiar nombre del canal
- POST/{instanceId}/newsletter/owner/transferTransferir propiedad del canal
- POST/{instanceId}/newsletter/pictureCambiar foto del canal
- POST/{instanceId}/newsletter/reactionReaccionar a una publicación del canal
- POST/{instanceId}/newsletter/searchBuscar canales
- POST/{instanceId}/newsletter/settingsConfiguración del canal
- POST/{instanceId}/newsletter/subscribeSuscribirse a actualizaciones del canal
- POST/{instanceId}/newsletter/unfollowDejar de seguir
- POST/{instanceId}/newsletter/unmuteReactivar canal
- POST/{instanceId}/newsletter/updatesActualizaciones del canal
- POST/{instanceId}/newsletter/viewedMarcar como visto
Campañas
- POST/{instanceId}/sender/advancedEnviar campaña en lote
- DELETE/{instanceId}/sender/clearallLimpiar toda la cola
- POST/{instanceId}/sender/cleardoneLimpiar campañas completadas
- POST/{instanceId}/sender/editControlar campaña
- GET/{instanceId}/sender/listfoldersListar campañas
- POST/{instanceId}/sender/listmessagesListar mensajes de la campaña
- POST/{instanceId}/sender/simpleEnviar mensaje simple
WhatsApp Business
- POST/{instanceId}/business/catalog/deleteEliminar producto del catálogo
- POST/{instanceId}/business/catalog/hideOcultar producto del catálogo
- POST/{instanceId}/business/catalog/infoInformación del producto
- POST/{instanceId}/business/catalog/listListar catálogo de productos
- POST/{instanceId}/business/catalog/showMostrar producto en el catálogo
- GET/{instanceId}/business/get/categoriesListar categorías comerciales
- POST/{instanceId}/business/get/profileVer perfil comercial
- POST/{instanceId}/business/update/profileActualizar perfil comercial
Configuración
- POST/{instanceId}/chat/labelsAplicar etiqueta al chat
- POST/{instanceId}/instance/connectConectar instancia
- POST/{instanceId}/instance/disconnectDesconectar instancia
- POST/{instanceId}/instance/presenceEstado de presencia
- GET/{instanceId}/instance/privacyVer privacidad
- POST/{instanceId}/instance/privacyCambiar privacidad
- GET/{instanceId}/instance/proxyVer proxy
- POST/{instanceId}/instance/proxyConfigurar proxy
- POST/{instanceId}/instance/resetReiniciar instancia
- GET/{instanceId}/instance/statusInformación y estado de la instancia
- POST/{instanceId}/instance/updateDelaySettingsConfigurar delay
- POST/{instanceId}/instance/updateInstanceNameRenombrar instancia
- POST/{instanceId}/label/editCrear / Editar etiqueta
- GET/{instanceId}/labelsListar etiquetas
- POST/{instanceId}/labels/refreshRecargar etiquetas
- POST/{instanceId}/quickreply/editCrear / Editar respuesta rápida
- GET/{instanceId}/quickreply/showallListar respuestas rápidas
Webhooks y Eventos
Cola Async
Chatbot e IA
- POST/{instanceId}/agent/editCrear/Editar agente de IA
- GET/{instanceId}/agent/listListar agentes de IA
- POST/{instanceId}/function/editCrear/Editar función API
- GET/{instanceId}/function/listListar funciones API
- POST/{instanceId}/knowledge/editCrear/Editar conocimiento
- GET/{instanceId}/knowledge/listListar conocimientos
- POST/{instanceId}/trigger/editCrear/Editar trigger
- GET/{instanceId}/trigger/listListar triggers
CRM y Leads
Integración con Chatwoot
Seguimiento de Meta
Consigue tus claves de API
Crea tu cuenta, conecta un número en minutos y empieza a usar la API. R$15 por número activo/mes, con un crédito de bienvenida al crear la cuenta, sujeto a la campaña vigente.