Upnify Documentación API
Inicia aquí · /integraciones/calendario

Integraciones

Consultar horarios de un calendario

POST/integraciones/calendario

Consulta los horarios del ejecutivo seleccionado por la configuración de un widget, para la semana de la fecha enviada y la siguiente. El widget debe tener guardias, días laborales y zona horaria configurados. Descarta los horarios con ocupado: true. La respuesta es un objeto, no un arreglo. Los errores devuelven un arreglo con code y msg. Conserva el ejecutivo y los componentes de fecha que usarás para reservar la cita. El ejemplo muestra los campos necesarios para elegir un horario; se omiten otros datos auxiliares de disponibilidad.

Parámetros

NombreTipoValidaciónDescripción
tokenStringRequeridoCuerpo: Token de integración utilizado para consultar la agenda. Se envía en el cuerpo, no solo en el encabezado.
tkWidgetStringRequeridoCuerpo: Identificador de un widget de calendario configurado.
fechaStringCuerpo: Fecha de referencia reconocida por JavaScript; usa ISO 8601. Si se omite, se usa la fecha actual.
zonaHorariaStringCuerpo: Zona horaria IANA del visitante.

Respuesta

NombreTipoDescripción
ejecutivoObjectDatos del ejecutivo seleccionado. Algunas propiedades pueden faltar si no hay disponibilidad.
ejecutivo.nombreStringNombre del ejecutivo.
ejecutivo.tkUsuarioStringIdentificador del ejecutivo.
ejecutivo.asuntoStringAsunto configurado para la cita.
ejecutivo.gmtIntegerValor GMT del ejecutivo; puede ser null. Conserva el valor para la reserva.
semanaActualObjectHorarios agrupados por las claves 1 a 7, de lunes a domingo. Cada valor es un arreglo.
semanaSiguienteObjectHorarios de la semana siguiente, con la misma estructura.
semanaActual.<dia>[]ObjectCada horario incluye fechaOriginal, slotSinAfectar, slotData, slotDataFin, fechaReal, ocupado y fechaFin. La misma estructura se usa en semanaSiguiente.
semanaActual.<dia>[].slotDataObjectComponentes year, month, day, hour y minute. month va de 0 a 11.
semanaActual.<dia>[].slotDataFinObjectComponentes de la fecha final, con month de 0 a 11.
semanaActual.<dia>[].ocupadoBooleantrue si el horario no debe ofrecerse para reserva.
gmtsObjectDatos auxiliares para interpretar las zonas horarias y los horarios. Su estructura contiene información de disponibilidad.

Solicitud

Consultar dos semanas de horarios

curl --request POST \
  --url https://api.upnify.com/integraciones/calendario \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "token": "P01AP00000000-0000-4000-8000-000000000001",
  "tkWidget": "W-00000000-0000-4000-8000-000000000001",
  "fecha": "2026-10-05T12:00:00-05:00",
  "zonaHoraria": "America/Cancun"
}'

Respuesta

Disponibilidad: extracto de respuesta (HTTP 200)

JSON
{
  "ejecutivo": {
    "nombre": "Persona de ejemplo",
    "tkUsuario": "U-00000000-0000-4000-8000-000000000001",
    "asunto": "Consulta de información",
    "gmt": 0
  },
  "semanaActual": {
    "1": [
      {
        "slotData": {
          "year": 2026,
          "month": 9,
          "day": 5,
          "hour": 10,
          "minute": 0
        },
        "slotDataFin": {
          "year": 2026,
          "month": 9,
          "day": 5,
          "hour": 10,
          "minute": 30
        },
        "ocupado": false
      }
    ],
    "2": [],
    "3": [],
    "4": [],
    "5": [],
    "6": [],
    "7": []
  },
  "semanaSiguiente": {
    "1": [],
    "2": [],
    "3": [],
    "4": [],
    "5": [],
    "6": [],
    "7": []
  },
  "gmts": {
    "zonaHorariaUsuario": "America/Cancun",
    "zonaHorariaGuardia": "America/Cancun",
    "diferenciaMinutos": 0
  }
}