Ir al contenido

Familias de endpoints

La API se sirve a través de un único gateway (api.rolchat.com) que envía cada familia de rutas al servicio que la gestiona. Esta página enumera todas las familias que el gateway expone a los clientes, agrupadas por módulo. Todas las familias comparten las convenciones - sobre, paginación, idempotencia, códigos de error -, así que la tabla te indica dónde vive un recurso y cómo se autentica la llamada.

Las rutas son prefijos: /api/v1/contacts cubre GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id, etc. Gana el prefijo más largo, por eso una subfamilia pública como /kb/public puede estar bajo un /kb autenticado.

GrupoQuién puede llamar
userMiembro de la cuenta - JWT o clave de API, X-Account-Id obligatoria
loginAnónimo, límites estrictos de inicio de sesión (10 por IP por minuto)
unauthenticatedAnónimo
widgetAnónimo, limitado por clave de sitio y origen (60 por sitio e IP por minuto)
webhook-inboundFirmado por el remitente - consulta Webhooks
partnerJWT de partner (portal de partners)

Auth & account

PrefijoServicioGrupo
/api/v1/authiam-servicelogin
/api/v1/captchaiam-serviceunauthenticated
/api/v1/meiam-serviceuser
/api/v1/accountsiam-serviceuser
/api/v1/account-settingsiam-serviceuser
/api/v1/usersiam-serviceuser
/api/v1/membersiam-serviceuser
/api/v1/rolesiam-serviceuser
/api/v1/tokensiam-serviceuser
/api/v1/staff-access-policyiam-serviceuser
/api/v1/staff-access-sessionsiam-serviceuser
/api/v1/presenceiam-serviceuser
/api/v1/workforceiam-serviceuser
/api/v1/sitessites-serviceuser
/api/v1/profileprofile-serviceuser
/api/v1/teamsteams-serviceuser
/api/v1/auditaudit-serviceuser

Conversations & inbox

PrefijoServicioGrupo
/api/v1/conversationsconversation-serviceuser
/api/v1/messagesconversation-serviceuser
/api/v1/conversation-tagsconversation-serviceuser
/api/v1/inboxesconversation-serviceuser
/api/v1/viewsconversation-serviceuser
/api/v1/templatesconversation-serviceuser
/api/v1/chat-routing-rulesconversation-serviceuser
/api/v1/macrosconversation-serviceuser
/api/v1/chat-settingsconversation-serviceuser
/api/v1/tasksconversation-serviceuser

CRM

PrefijoServicioGrupo
/api/v1/leadscrm-serviceuser
/api/v1/contactscrm-serviceuser
/api/v1/companiescrm-serviceuser
/api/v1/dealscrm-serviceuser
/api/v1/pipelinescrm-serviceuser
/api/v1/lead-statusescrm-serviceuser
/api/v1/contact-tagscrm-serviceuser
/api/v1/segmentscrm-serviceuser
/api/v1/lead-routing-rulescrm-serviceuser
/api/v1/crm-settingscrm-serviceuser
/api/v1/crm/campaignscrm-serviceuser
/api/v1/custom-fieldsmeta-serviceuser

Tickets

PrefijoServicioGrupo
/api/v1/ticketsticket-serviceuser
/api/v1/ticket-queuesticket-serviceuser
/api/v1/ticket-settingsticket-serviceuser
/api/v1/ticket-sla-policiesticket-serviceuser
/api/v1/ticket-custom-fieldsticket-serviceuser
/api/v1/ticket-tagsticket-serviceuser

Channels & widget

PrefijoServicioGrupo
/api/v1/channelschannel-serviceuser
/api/v1/widget-configschannel-serviceuser
/api/v1/widgetvisitor-servicewidget
/api/v1/webhookschannel-servicewebhook-inbound

Visitors

PrefijoServicioGrupo
/api/v1/visitorsvisitor-serviceuser
/api/v1/geo-sourcevisitor-serviceuser
/api/v1/funnelsvisitor-serviceuser

Knowledge base

PrefijoServicioGrupo
/api/v1/kbkb-serviceuser
/api/v1/kb/publickb-servicewidget

Marketing

PrefijoServicioGrupo
/api/v1/marketingmarketing-serviceuser
/api/v1/marketing/publicmarketing-servicewidget
/api/v1/surveysmarketing-serviceuser
/api/v1/survey-responsesmarketing-serviceuser
/api/v1/meetingsmarketing-serviceuser

Phone

PrefijoServicioGrupo
/api/v1/phone/twiliophone-servicewebhook-inbound
/api/v1/phonephone-serviceuser

Automation

PrefijoServicioGrupo
/api/v1/automationautomation-serviceuser

Reports

PrefijoServicioGrupo
/api/v1/reportsanalytics-serviceuser
/api/v1/dashboardsanalytics-serviceuser
/api/v1/kpianalytics-serviceuser
PrefijoServicioGrupo
/api/v1/consentprivacy-servicewidget
/api/v1/privacyprivacy-serviceuser
/api/v1/privacy/publicprivacy-servicewidget

AI

PrefijoServicioGrupo
/api/v1/aiplugin-serviceuser · tiempo de espera de 60 s
/api/v1/ai/assistant/replyplugin-servicewebhook-inbound

Notifications

PrefijoServicioGrupo
/api/v1/notifications-policynotification-serviceuser
/api/v1/notificationsnotification-serviceuser
/api/v1/notification-templatesnotification-serviceuser
/api/v1/notification-delivery-logsnotification-serviceuser
/api/v1/pushnotification-serviceuser

Media

PrefijoServicioGrupo
/api/v1/mediamedia-serviceuser

Billing

PrefijoServicioGrupo
/api/v1/billingbilling-serviceuser
/api/v1/billing/webhooks/stripebilling-servicewebhook-inbound

Partner portal

PrefijoServicioGrupo
/api/v1/partnerpartner-portal-servicepartner
/api/v1/partner/authiam-servicelogin
/api/v1/partner/invitationspartner-portal-servicelogin
/api/v1/partner/auth/mfa/enrolliam-servicepartner
/api/v1/partner/auth/mfa/confirmiam-servicepartner
/api/v1/partner/auth/step-upiam-servicepartner
/api/v1/rpartner-portal-servicewidget

Identity verification (KYC)

PrefijoServicioGrupo
/api/v1/kyc/webhooks/sumsubkyc-servicewebhook-inbound
/api/v1/kyc/webhooks/didwwkyc-servicewebhook-inbound
/api/v1/kyckyc-serviceuser

Otras

PrefijoServicioGrupo
/api/v1/auth/meiam-serviceuser
/api/v1/auth/sessionsiam-serviceuser
/api/v1/auth/mfaiam-serviceuser
/api/v1/auth/email-changeiam-serviceuser
/api/v1/auth/swap-companyiam-serviceuser
/api/v1/privacy/policiesprivacy-serviceuser
/api/v1/complianceprivacy-serviceuser
/api/v1/identity-graphidentity-graph-serviceuser

Esta tabla se genera a partir de la tabla de rutas del gateway en el repositorio del backend, copiada como instantánea en este sitio. Una comprobación antes de cada despliegue compara la instantánea con la tabla de rutas actual, así que no se puede añadir ni quitar una familia en el producto sin que cambie esta página. Se excluyen las rutas internas de la consola del personal. El documento OpenAPI legible por máquina se describe en la página OpenAPI.