Auphere
Menú de documentación

API de Partners de Auphere · Guías

/ v0.1

Administradores

Define qué teléfonos pueden hablar con el agente de un cliente, y qué puede hacer cada uno.

En verticales admin-only el agente es un asistente privado del negocio, no un chatbot público. Responde solo a los teléfonos de esta lista. Cualquier otro que escriba queda registrado para auditoría pero no recibe respuesta — ni acuse de lectura, así que en una línea en coexistencia el mensaje sigue sin leer hasta que lo abra una persona.

Roles

RolPuedeNo puede
fullTodo: consultas y cambios (registrar un pago, crear una cuenta, aplicar un descuento…)
readonlySolo consultas: saldos, detalle de cuentas, listadosCualquier escritura en tu sistema

El rol se aplica en el runtime, no por prompt: un admin readonly ni siquiera ve las herramientas de escritura, así que no se puede convencer al agente de usarlas.

Reemplazar la lista

PUT reemplaza la whitelist completa — envía la lista entera cada vez, no un delta. Requiere el scope provision.

Petición
PUT https://api.auphere.com/v1/partners/clients/{external_client_ref}/admins
Authorization: Bearer ak_live_…
Content-Type: application/json

{
  "admins": [
    { "phone": "+584241234567", "name": "Ana",  "role": "full" },
    { "phone": "+584249990000", "name": "Luis", "role": "readonly" }
  ]
}
Respuesta
{
  "admin_only": true,
  "admins": [
    { "phone": "+584241234567", "name": "Ana",  "role": "full" },
    { "phone": "+584249990000", "name": "Luis", "role": "readonly" }
  ]
}
phonestringRequerido
Se recomienda E.164. Normalizamos el formato, pero un número con menos de 7 dígitos se rechaza con 400 — es demasiado ambiguo para dar acceso admin.
namestring
Metadato para tu propia trazabilidad. No afecta al acceso.
role"full" | "readonly"
Por defecto full si se omite.

Qué pasa por dentro

Cada actualización promueve una versión nueva y auditada del agente del cliente — así un cambio equivocado es reversible y siempre se puede ver quién tocó la whitelist y cuándo. El cambio aplica desde el siguiente mensaje; las conversaciones en curso no se interrumpen.