Upnify Documentación API
Inicia aquí · /integraciones

Integraciones

Crear una integración

POST/integraciones

Crea una integración en la cuenta de la sesión. config debe contener un objeto JSON válido con la configuración correspondiente al tipo elegido. Por ejemplo, una integración API puede definir nombre, tkUsuario, tkFase, tkOrigen y tkEtiqueta para recibir contactos. Para los tipos 7 y 10 también se obtiene idFormulario. Conserva los tokens de la respuesta como credenciales: no los registres ni los publiques. Una cuenta Zoom ya vinculada devuelve un error de conflicto.

Parámetros

NombreTipoValidaciónDescripción
tokenStringRequeridoEncabezado: Token de sesión vigente obtenido al autenticarte. No lo registres ni lo expongas.
tipoIntegracionIntegerCuerpo: Tipo de integración. Por ejemplo, 7 para API o 10 para formulario HTML.
configStringRequeridoCuerpo: Configuración de la integración como objeto JSON serializado. Su estructura depende del tipo.
config2StringCuerpo: Configuración complementaria según el proveedor. Puede contener información confidencial.
config3StringCuerpo: Configuración complementaria según el proveedor. Puede contener información confidencial.
widgetConfigStringCuerpo: Configuración del widget como texto JSON; se utiliza para integraciones de tipo 12.
account_idStringCuerpo: Identificador de la cuenta de Zoom, necesario para el tipo 23. También se admite accountId o config2; la cuenta no puede estar vinculada a otra integración.

Respuesta

NombreTipoDescripción
codeIntegerCódigo de resultado. El valor 0 indica que la operación terminó sin error.
msgStringMensaje de resultado. Su texto puede variar.
detailsArray<Object>Arreglo con los datos de la operación.
details[].tkIntegracionStringIdentificador de la integración para su administración.
details[].tkIntegracionSesionStringToken completo para recibir contactos o autenticar una integración. No lo expongas.
details[].idFormularioStringIdentificador del formulario para los tipos 7 y 10.

Solicitud

Crear una integración API

curl --request POST \
  --url https://api.upnify.com/integraciones \
  --header 'Accept: application/json' \
  --header 'token: TOKEN-SESION-EJEMPLO' \
  --header 'Content-Type: application/json' \
  --data '{
  "tipoIntegracion": 7,
  "config": "{\"nombre\": \"Formulario de ejemplo\"}"
}'

Respuesta

Integración API creada (HTTP 200)

JSON
[
  {
    "code": 0,
    "msg": "Ok",
    "details": [
      {
        "tkIntegracion": "AP00000000-0000-4000-8000-000000000001",
        "tkIntegracionSesion": "P01AP00000000-0000-4000-8000-000000000001",
        "idFormulario": "eyJlIjoxMjMsInQiOiJUT0tFTi1JTlRFR1JBQ0lPTi1FSkVNUExPIn0"
      }
    ]
  }
]