Calendario
Te explicamos como utilizar Calendario mediante Rest API.
Con nuestra Rest API de calendario podrás agendar citas o reuniones para tus clientes de forma fácil.
Los endpoints a continuación son públicos, es decir, se antepone /public/ como medio diferenciador de endpoints privados.
Obtener servicios de calendario
GET https://api.videsk.io/public/video-contact-center/services
Podrás obtener el listado de los servicios públicos disponibles
Headers
Authorization*
String
Bearer {token}
Content-Type*
String
application/json
{
"total":1,
"limit":10,
"skip":0,
"data":[
{
"users":[
{
"_id":"63bdbf3230013a2792550a1c",
"firstname":"John",
"lastname":"Doe"
},
{
"_id":"63bdbf3b25ab497401602d07",
"firstname":"Mark",
"lastname":"Zuckerberg"
}
],
"title":"My service",
"description":"Service description",
"automatic":false,
"id":"63bdbf49394aad976d4aa43b"
}
]
}Obtener días del mes disponibles por id de servicio
GET https://api.videsk.io/public/video-contact-center/services/:id/dates
Días del mes disponibles basado en el ID del servicio
Path Parameters
id*
String
ID del servicio
Query Parameters
date*
Date
Mes en formato ISO-8601
timezone*
String
Zona horaria en formato ISO-8601
Headers
Authorization*
String
Bearer {token}
Content-Type*
String
application/json
Obtener horas del día disponibles por id de servicio
GET https://api.videsk.io/public/video-contact-center/services/:id/hours
Horas del días disponibles basado en el ID del servicio
Path Parameters
id*
String
ID del servicio
Query Parameters
date*
Date
Hora en formato ISO-8601
timezone*
String
Zona horaria en formato ISO-8601
Headers
Authorization*
String
Bearer {token}
Content-Type*
String
application/json
Las fechas están en ISO-8601, puedes utilizar nuestro SDK de calendario para formatear fechas en zona horaria local.
Obtener días del mes disponibles por id de usuario
GET https://api.videsk.io/public/video-contact-center/users/:id/dates
Días del mes disponibles basado en el ID del servicio
Path Parameters
id*
String
ID del usuario
Query Parameters
date*
Date
Mes en formato ISO-8601
timezone*
String
Zona horaria en formato ISO-8601
Headers
Authorization*
String
Bearer {token}
Content-Type*
String
application/json
Las fechas están en ISO-8601, puedes utilizar nuestro SDK de calendario para formatear fechas en zona horaria local.
Obtener horas del día disponibles por id de usuario
GET https://api.videsk.io/public/video-contact-center/users/:id/hours
Horas del días disponibles basado en el ID del usuario
Path Parameters
id*
String
ID del usuario
Query Parameters
date*
String
Hora en formato ISO-8601
timezone*
String
Zona horaria en formato ISO-8601
Headers
Authorization*
String
Bearer {token}
Content-Type*
String
application/json
Las fechas están en ISO-8601, puedes utilizar nuestro SDK de calendario para formatear fechas en zona horaria local.
Agendar una hora por servicio
POST https://api.videsk.io/public/video-contact-center/schedule/service/:id
Agendar una hora mediante un servicio con selección automáticamente de agente
Path Parameters
id*
String
ID de servicio
Headers
Authorization*
String
Bearer {token}
Content-Type*
String
application/json
Request Body
startAt*
Date
Fecha en formato ISO-8601
timezone*
String
Zona horaria en formato ISO-8601
form*
Array
Campos de formulario
referrer*
String
Campaña o web referido
Agendar una hora por agente
POST https://api.videsk.io/public/video-contact-center/schedule/user/:id
Agendar una hora mediante un agente
Path Parameters
id*
String
ID del usuario
Headers
Authorization*
String
Bearer {token}
Content-Type*
String
application/json
Request Body
startAt*
Date
Fecha en formato ISO-8601
timezone*
String
Zona horaria en formato ISO-8601
form*
Array
Campos de formulario
referrer*
String
Campaña o web referido
service*
String
ID del servicio
Cancelar una hora
POST https://api.videsk.io/public/video-contact-center/schedule/cancel
Cancelar una hora usando actionToken
Headers
Authorization*
String
Bearer {actionToken}
Content-Type*
String
application/json
Request Body
cancelReason
String
Razón de cancelación
Reagendar una hora
POST https://api.videsk.io/public/video-contact-center/schedule/reschedule
Reagendar una hora usando actionToken
Headers
Authorization*
String
Bearer {actionToken}
Content-Type*
String
application/json
Request Body
date*
Date
Fecha en formato ISO-8601
Obtener información de una cita
GET https://api.videsk.io/public/video-contact-center/schedule/info
Obtener la información de una cita como agente, servicio fecha de inicio, fin y estado.
Headers
Authorization*
String
Bearer {accessToken}
Content-Type*
String
application/json
Última actualización
¿Te fue útil?