description
Te explicamos como utilizar Calendario mediante Rest API.

Calendario

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.

{% hint style="info" %} Te sugerimos revisar el diagrama de flujos para tener una vista del orden de peticiones a realizar, antes de utilizar nuestra API. {% endhint %}

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

Name	Type	Description
Authorization*	String	Bearer {token}
Content-Type*	String	application/json

{% tabs %} {% tab title="200: OK Listado de servicios" %} {% code lineNumbers="true" %}

{
   "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"
      }
   ]
}

{% endcode %} {% endtab %}

{% tab title="401: Unauthorized API Key invalido" %} Referencia de errores en autorización. {% endtab %} {% endtabs %}

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

Name	Type	Description
id*	String	ID del servicio

Query Parameters

Name	Type	Description
date*	Date	Mes en formato ISO-8601
timezone*	String	Zona horaria en formato ISO-8601

Headers

Name	Type	Description
Authorization*	String	Bearer {token}
Content-Type*	String	application/json

{% tabs %} {% tab title="200: OK Listado de días del mes" %}

[
	"2023-02-01T03:00:00.000Z",
	"2023-02-02T03:00:00.000Z",
	"2023-02-03T03:00:00.000Z",
	"2023-02-04T03:00:00.000Z",
	"2023-02-05T03:00:00.000Z",
	"2023-02-06T03:00:00.000Z",
	"2023-02-07T03:00:00.000Z",
	"2023-02-08T03:00:00.000Z",
	"2023-02-09T03:00:00.000Z",
	"2023-02-10T03:00:00.000Z",
	"2023-02-11T03:00:00.000Z",
	"2023-02-12T03:00:00.000Z",
	"2023-02-13T03:00:00.000Z",
	"2023-02-14T03:00:00.000Z",
	"2023-02-15T03:00:00.000Z",
	"2023-02-16T03:00:00.000Z",
	"2023-02-17T03:00:00.000Z",
	"2023-02-18T03:00:00.000Z",
	"2023-02-19T03:00:00.000Z",
	"2023-02-20T03:00:00.000Z",
	"2023-02-21T03:00:00.000Z",
	"2023-02-22T03:00:00.000Z",
	"2023-02-23T03:00:00.000Z",
	"2023-02-24T03:00:00.000Z",
	"2023-02-25T03:00:00.000Z",
	"2023-02-26T03:00:00.000Z",
	"2023-02-27T03:00:00.000Z",
	"2023-02-28T03:00:00.000Z"
]

{% endtab %}

{% tab title="401: Unauthorized API Key invalido" %} Referencia de errores en autorización. {% endtab %}

{% tab title="400: Bad Request Fecha está en el pasado" %}

{
	"name": "BadRequest",
	"message": "The date can not be in the past.",
	"code": 400,
	"className": "bad-request",
	"data": "dateInPast",
	"errors": {}
}

{% endtab %}

{% tab title="400: Bad Request Fecha inválida" %}

{
	"name": "BadRequest",
	"message": "A valid \"date\" is required",
	"code": 400,
	"className": "bad-request",
	"data": "date",
	"errors": {}
}

{% endtab %}

{% tab title="400: Bad Request Zona horaria inválida" %}

{
	"name": "BadRequest",
	"message": "A valid \"timezone\" is required",
	"code": 400,
	"className": "bad-request",
	"data": "timezone",
	"errors": {}
}

{% endtab %} {% endtabs %}

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

Name	Type	Description
id*	String	ID del servicio

Query Parameters

Name	Type	Description
date*	Date	Hora en formato ISO-8601
timezone*	String	Zona horaria en formato ISO-8601

Headers

Name	Type	Description
Authorization*	String	Bearer {token}
Content-Type*	String	application/json

{% tabs %} {% tab title="200: OK Listado de horas" %} Las fechas están en ISO-8601, puedes utilizar nuestro SDK de calendario para formatear fechas en zona horaria local.

[
	"2023-02-24T11:00:00.000Z",
	"2023-02-24T11:05:00.000Z",
	"2023-02-24T11:10:00.000Z",
	"2023-02-24T11:15:00.000Z",
	"2023-02-24T11:20:00.000Z",
	"2023-02-24T11:25:00.000Z",
	"2023-02-24T11:30:00.000Z",
	"2023-02-24T11:35:00.000Z",
	"2023-02-24T11:40:00.000Z",
	"2023-02-24T11:45:00.000Z",
	"2023-02-24T11:50:00.000Z",
	"2023-02-24T11:55:00.000Z",
	"2023-02-24T12:00:00.000Z",
	"2023-02-24T12:05:00.000Z",
	"2023-02-24T12:10:00.000Z",
	"2023-02-24T12:15:00.000Z",
	"2023-02-24T12:20:00.000Z",
	"2023-02-24T12:25:00.000Z",
	"2023-02-24T12:30:00.000Z",
	"2023-02-24T12:35:00.000Z",
	"2023-02-24T12:40:00.000Z",
	"2023-02-24T12:45:00.000Z",
	"2023-02-24T12:50:00.000Z",
	"2023-02-24T12:55:00.000Z",
	"2023-02-24T16:00:00.000Z",
	"2023-02-24T16:05:00.000Z",
	"2023-02-24T16:10:00.000Z",
	"2023-02-24T16:15:00.000Z",
	"2023-02-24T16:20:00.000Z",
	"2023-02-24T16:25:00.000Z",
	"2023-02-24T16:30:00.000Z",
	"2023-02-24T16:35:00.000Z",
	"2023-02-24T16:40:00.000Z",
	"2023-02-24T16:45:00.000Z",
	"2023-02-24T16:50:00.000Z",
	"2023-02-24T16:55:00.000Z",
	"2023-02-24T17:00:00.000Z",
	"2023-02-24T17:05:00.000Z",
	"2023-02-24T17:10:00.000Z",
	"2023-02-24T17:15:00.000Z",
	"2023-02-24T17:20:00.000Z",
	"2023-02-24T17:25:00.000Z",
	"2023-02-24T17:30:00.000Z",
	"2023-02-24T17:35:00.000Z",
	"2023-02-24T17:40:00.000Z",
	"2023-02-24T17:45:00.000Z",
	"2023-02-24T17:50:00.000Z",
	"2023-02-24T17:55:00.000Z",
	"2023-02-24T18:00:00.000Z",
	"2023-02-24T18:05:00.000Z",
	"2023-02-24T18:10:00.000Z",
	"2023-02-24T18:15:00.000Z",
	"2023-02-24T18:20:00.000Z",
	"2023-02-24T18:25:00.000Z",
	"2023-02-24T18:30:00.000Z",
	"2023-02-24T18:35:00.000Z",
	"2023-02-24T18:40:00.000Z",
	"2023-02-24T18:45:00.000Z",
	"2023-02-24T18:50:00.000Z",
	"2023-02-24T18:55:00.000Z",
	"2023-02-24T19:00:00.000Z",
	"2023-02-24T19:05:00.000Z",
	"2023-02-24T19:10:00.000Z",
	"2023-02-24T19:15:00.000Z",
	"2023-02-24T19:20:00.000Z",
	"2023-02-24T19:25:00.000Z",
	"2023-02-24T19:30:00.000Z",
	"2023-02-24T19:35:00.000Z",
	"2023-02-24T19:40:00.000Z",
	"2023-02-24T19:45:00.000Z",
	"2023-02-24T19:50:00.000Z",
	"2023-02-24T19:55:00.000Z",
	"2023-02-24T20:00:00.000Z",
	"2023-02-24T20:05:00.000Z",
	"2023-02-24T20:10:00.000Z",
	"2023-02-24T20:15:00.000Z",
	"2023-02-24T20:20:00.000Z",
	"2023-02-24T20:25:00.000Z",
	"2023-02-24T20:30:00.000Z",
	"2023-02-24T20:35:00.000Z",
	"2023-02-24T20:40:00.000Z",
	"2023-02-24T20:45:00.000Z",
	"2023-02-24T20:50:00.000Z",
	"2023-02-24T20:55:00.000Z",
	"2023-02-24T21:00:00.000Z",
	"2023-02-24T21:05:00.000Z",
	"2023-02-24T21:10:00.000Z",
	"2023-02-24T21:15:00.000Z",
	"2023-02-24T21:20:00.000Z",
	"2023-02-24T21:25:00.000Z",
	"2023-02-24T21:30:00.000Z",
	"2023-02-24T21:35:00.000Z",
	"2023-02-24T21:40:00.000Z",
	"2023-02-24T21:45:00.000Z",
	"2023-02-24T21:50:00.000Z",
	"2023-02-24T21:55:00.000Z",
	"2023-02-24T22:00:00.000Z",
	"2023-02-24T22:05:00.000Z",
	"2023-02-24T22:10:00.000Z",
	"2023-02-24T22:15:00.000Z",
	"2023-02-24T22:20:00.000Z",
	"2023-02-24T22:25:00.000Z",
	"2023-02-24T22:30:00.000Z",
	"2023-02-24T22:35:00.000Z",
	"2023-02-24T22:40:00.000Z",
	"2023-02-24T22:45:00.000Z",
	"2023-02-24T22:50:00.000Z",
	"2023-02-24T22:55:00.000Z",
	"2023-02-24T23:00:00.000Z",
	"2023-02-24T23:05:00.000Z",
	"2023-02-24T23:10:00.000Z",
	"2023-02-24T23:15:00.000Z",
	"2023-02-24T23:20:00.000Z",
	"2023-02-24T23:25:00.000Z",
	"2023-02-24T23:30:00.000Z",
	"2023-02-24T23:35:00.000Z",
	"2023-02-24T23:40:00.000Z",
	"2023-02-24T23:45:00.000Z",
	"2023-02-24T23:50:00.000Z",
	"2023-02-24T23:55:00.000Z",
	"2023-02-25T00:00:00.000Z",
	"2023-02-25T00:05:00.000Z",
	"2023-02-25T00:10:00.000Z",
	"2023-02-25T00:15:00.000Z",
	"2023-02-25T00:20:00.000Z",
	"2023-02-25T00:25:00.000Z",
	"2023-02-25T00:30:00.000Z",
	"2023-02-25T00:35:00.000Z",
	"2023-02-25T00:40:00.000Z",
	"2023-02-25T00:45:00.000Z",
	"2023-02-25T00:50:00.000Z",
	"2023-02-25T00:55:00.000Z",
	"2023-02-25T01:00:00.000Z",
	"2023-02-25T01:05:00.000Z",
	"2023-02-25T01:10:00.000Z",
	"2023-02-25T01:15:00.000Z",
	"2023-02-25T01:20:00.000Z",
	"2023-02-25T01:25:00.000Z",
	"2023-02-25T01:30:00.000Z",
	"2023-02-25T01:35:00.000Z",
	"2023-02-25T01:40:00.000Z",
	"2023-02-25T01:45:00.000Z",
	"2023-02-25T01:50:00.000Z",
	"2023-02-25T01:55:00.000Z",
	"2023-02-25T02:00:00.000Z",
	"2023-02-25T02:05:00.000Z",
	"2023-02-25T02:10:00.000Z",
	"2023-02-25T02:15:00.000Z",
	"2023-02-25T02:20:00.000Z",
	"2023-02-25T02:25:00.000Z",
	"2023-02-25T02:30:00.000Z",
	"2023-02-25T02:35:00.000Z",
	"2023-02-25T02:40:00.000Z",
	"2023-02-25T02:45:00.000Z",
	"2023-02-25T02:50:00.000Z",
	"2023-02-25T02:55:00.000Z"
]

{% endtab %}

{% tab title="400: Bad Request Fecha está en el pasado" %}

{
	"name": "BadRequest",
	"message": "The date can not be in the past.",
	"code": 400,
	"className": "bad-request",
	"data": "dateInPast",
	"errors": {}
}

{% endtab %}

{% tab title="400: Bad Request Fecha inválida" %}

{
	"name": "BadRequest",
	"message": "A valid \"date\" is required",
	"code": 400,
	"className": "bad-request",
	"data": "date",
	"errors": {}
}

{% endtab %}

{% tab title="400: Bad Request Zona horaria inválida" %}

{
	"name": "BadRequest",
	"message": "A valid \"timezone\" is required",
	"code": 400,
	"className": "bad-request",
	"data": "timezone",
	"errors": {}
}

{% endtab %}

{% tab title="401: Unauthorized API Key inválido" %} Referencia de errores en autorización. {% endtab %} {% endtabs %}

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

Name	Type	Description
id*	String	ID del usuario

Query Parameters

Name	Type	Description
date*	Date	Mes en formato ISO-8601
timezone*	String	Zona horaria en formato ISO-8601

Headers

Name	Type	Description
Authorization*	String	Bearer {token}
Content-Type*	String	application/json

{% tabs %} {% tab title="200: OK Listado de días del mes" %} Las fechas están en ISO-8601, puedes utilizar nuestro SDK de calendario para formatear fechas en zona horaria local.

[
	"2023-02-01T03:00:00.000Z",
	"2023-02-02T03:00:00.000Z",
	"2023-02-03T03:00:00.000Z",
	"2023-02-04T03:00:00.000Z",
	"2023-02-05T03:00:00.000Z",
	"2023-02-06T03:00:00.000Z",
	"2023-02-07T03:00:00.000Z",
	"2023-02-08T03:00:00.000Z",
	"2023-02-09T03:00:00.000Z",
	"2023-02-10T03:00:00.000Z",
	"2023-02-11T03:00:00.000Z",
	"2023-02-12T03:00:00.000Z",
	"2023-02-13T03:00:00.000Z",
	"2023-02-14T03:00:00.000Z",
	"2023-02-15T03:00:00.000Z",
	"2023-02-16T03:00:00.000Z",
	"2023-02-17T03:00:00.000Z",
	"2023-02-18T03:00:00.000Z",
	"2023-02-19T03:00:00.000Z",
	"2023-02-20T03:00:00.000Z",
	"2023-02-21T03:00:00.000Z",
	"2023-02-22T03:00:00.000Z",
	"2023-02-23T03:00:00.000Z",
	"2023-02-24T03:00:00.000Z",
	"2023-02-25T03:00:00.000Z",
	"2023-02-26T03:00:00.000Z",
	"2023-02-27T03:00:00.000Z",
	"2023-02-28T03:00:00.000Z"
]

{% endtab %}

{% tab title="400: Bad Request Fecha está en el pasado" %}

{
	"name": "BadRequest",
	"message": "The date can not be in the past.",
	"code": 400,
	"className": "bad-request",
	"data": "dateInPast",
	"errors": {}
}

{% endtab %}

{% tab title="400: Bad Request Fecha inválida" %}

{
	"name": "BadRequest",
	"message": "A valid \"date\" is required",
	"code": 400,
	"className": "bad-request",
	"data": "date",
	"errors": {}
}

{% endtab %}

{% tab title="400: Bad Request Zona horaria inválida" %}

{
	"name": "BadRequest",
	"message": "A valid \"timezone\" is required",
	"code": 400,
	"className": "bad-request",
	"data": "timezone",
	"errors": {}
}

{% endtab %}

{% tab title="401: Unauthorized API Key invalido" %} Referencia de errores en autorización. {% endtab %} {% endtabs %}

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

Name	Type	Description
id*	String	ID del usuario

Query Parameters

Name	Type	Description
date*	String	Hora en formato ISO-8601
timezone*	String	Zona horaria en formato ISO-8601

Headers

Name	Type	Description
Authorization*	String	Bearer {token}
Content-Type*	String	application/json

{% tabs %} {% tab title="200: OK Listado de horas" %} Las fechas están en ISO-8601, puedes utilizar nuestro SDK de calendario para formatear fechas en zona horaria local.

[
	"2023-02-24T11:00:00.000Z",
	"2023-02-24T11:05:00.000Z",
	"2023-02-24T11:10:00.000Z",
	"2023-02-24T11:15:00.000Z",
	"2023-02-24T11:20:00.000Z",
	"2023-02-24T11:25:00.000Z",
	"2023-02-24T11:30:00.000Z",
	"2023-02-24T11:35:00.000Z",
	"2023-02-24T11:40:00.000Z",
	"2023-02-24T11:45:00.000Z",
	"2023-02-24T11:50:00.000Z",
	"2023-02-24T11:55:00.000Z",
	"2023-02-24T12:00:00.000Z",
	"2023-02-24T12:05:00.000Z",
	"2023-02-24T12:10:00.000Z",
	"2023-02-24T12:15:00.000Z",
	"2023-02-24T12:20:00.000Z",
	"2023-02-24T12:25:00.000Z",
	"2023-02-24T12:30:00.000Z",
	"2023-02-24T12:35:00.000Z",
	"2023-02-24T12:40:00.000Z",
	"2023-02-24T12:45:00.000Z",
	"2023-02-24T12:50:00.000Z",
	"2023-02-24T12:55:00.000Z",
	"2023-02-24T16:00:00.000Z",
	"2023-02-24T16:05:00.000Z",
	"2023-02-24T16:10:00.000Z",
	"2023-02-24T16:15:00.000Z",
	"2023-02-24T16:20:00.000Z",
	"2023-02-24T16:25:00.000Z",
	"2023-02-24T16:30:00.000Z",
	"2023-02-24T16:35:00.000Z",
	"2023-02-24T16:40:00.000Z",
	"2023-02-24T16:45:00.000Z",
	"2023-02-24T16:50:00.000Z",
	"2023-02-24T16:55:00.000Z",
	"2023-02-24T17:00:00.000Z",
	"2023-02-24T17:05:00.000Z",
	"2023-02-24T17:10:00.000Z",
	"2023-02-24T17:15:00.000Z",
	"2023-02-24T17:20:00.000Z",
	"2023-02-24T17:25:00.000Z",
	"2023-02-24T17:30:00.000Z",
	"2023-02-24T17:35:00.000Z",
	"2023-02-24T17:40:00.000Z",
	"2023-02-24T17:45:00.000Z",
	"2023-02-24T17:50:00.000Z",
	"2023-02-24T17:55:00.000Z",
	"2023-02-24T18:00:00.000Z",
	"2023-02-24T18:05:00.000Z",
	"2023-02-24T18:10:00.000Z",
	"2023-02-24T18:15:00.000Z",
	"2023-02-24T18:20:00.000Z",
	"2023-02-24T18:25:00.000Z",
	"2023-02-24T18:30:00.000Z",
	"2023-02-24T18:35:00.000Z",
	"2023-02-24T18:40:00.000Z",
	"2023-02-24T18:45:00.000Z",
	"2023-02-24T18:50:00.000Z",
	"2023-02-24T18:55:00.000Z",
	"2023-02-24T19:00:00.000Z",
	"2023-02-24T19:05:00.000Z",
	"2023-02-24T19:10:00.000Z",
	"2023-02-24T19:15:00.000Z",
	"2023-02-24T19:20:00.000Z",
	"2023-02-24T19:25:00.000Z",
	"2023-02-24T19:30:00.000Z",
	"2023-02-24T19:35:00.000Z",
	"2023-02-24T19:40:00.000Z",
	"2023-02-24T19:45:00.000Z",
	"2023-02-24T19:50:00.000Z",
	"2023-02-24T19:55:00.000Z",
	"2023-02-24T20:00:00.000Z",
	"2023-02-24T20:05:00.000Z",
	"2023-02-24T20:10:00.000Z",
	"2023-02-24T20:15:00.000Z",
	"2023-02-24T20:20:00.000Z",
	"2023-02-24T20:25:00.000Z",
	"2023-02-24T20:30:00.000Z",
	"2023-02-24T20:35:00.000Z",
	"2023-02-24T20:40:00.000Z",
	"2023-02-24T20:45:00.000Z",
	"2023-02-24T20:50:00.000Z",
	"2023-02-24T20:55:00.000Z",
	"2023-02-24T21:00:00.000Z",
	"2023-02-24T21:05:00.000Z",
	"2023-02-24T21:10:00.000Z",
	"2023-02-24T21:15:00.000Z",
	"2023-02-24T21:20:00.000Z",
	"2023-02-24T21:25:00.000Z",
	"2023-02-24T21:30:00.000Z",
	"2023-02-24T21:35:00.000Z",
	"2023-02-24T21:40:00.000Z",
	"2023-02-24T21:45:00.000Z",
	"2023-02-24T21:50:00.000Z",
	"2023-02-24T21:55:00.000Z",
	"2023-02-24T22:00:00.000Z",
	"2023-02-24T22:05:00.000Z",
	"2023-02-24T22:10:00.000Z",
	"2023-02-24T22:15:00.000Z",
	"2023-02-24T22:20:00.000Z",
	"2023-02-24T22:25:00.000Z",
	"2023-02-24T22:30:00.000Z",
	"2023-02-24T22:35:00.000Z",
	"2023-02-24T22:40:00.000Z",
	"2023-02-24T22:45:00.000Z",
	"2023-02-24T22:50:00.000Z",
	"2023-02-24T22:55:00.000Z",
	"2023-02-24T23:00:00.000Z",
	"2023-02-24T23:05:00.000Z",
	"2023-02-24T23:10:00.000Z",
	"2023-02-24T23:15:00.000Z",
	"2023-02-24T23:20:00.000Z",
	"2023-02-24T23:25:00.000Z",
	"2023-02-24T23:30:00.000Z",
	"2023-02-24T23:35:00.000Z",
	"2023-02-24T23:40:00.000Z",
	"2023-02-24T23:45:00.000Z",
	"2023-02-24T23:50:00.000Z",
	"2023-02-24T23:55:00.000Z",
	"2023-02-25T00:00:00.000Z",
	"2023-02-25T00:05:00.000Z",
	"2023-02-25T00:10:00.000Z",
	"2023-02-25T00:15:00.000Z",
	"2023-02-25T00:20:00.000Z",
	"2023-02-25T00:25:00.000Z",
	"2023-02-25T00:30:00.000Z",
	"2023-02-25T00:35:00.000Z",
	"2023-02-25T00:40:00.000Z",
	"2023-02-25T00:45:00.000Z",
	"2023-02-25T00:50:00.000Z",
	"2023-02-25T00:55:00.000Z",
	"2023-02-25T01:00:00.000Z",
	"2023-02-25T01:05:00.000Z",
	"2023-02-25T01:10:00.000Z",
	"2023-02-25T01:15:00.000Z",
	"2023-02-25T01:20:00.000Z",
	"2023-02-25T01:25:00.000Z",
	"2023-02-25T01:30:00.000Z",
	"2023-02-25T01:35:00.000Z",
	"2023-02-25T01:40:00.000Z",
	"2023-02-25T01:45:00.000Z",
	"2023-02-25T01:50:00.000Z",
	"2023-02-25T01:55:00.000Z",
	"2023-02-25T02:00:00.000Z",
	"2023-02-25T02:05:00.000Z",
	"2023-02-25T02:10:00.000Z",
	"2023-02-25T02:15:00.000Z",
	"2023-02-25T02:20:00.000Z",
	"2023-02-25T02:25:00.000Z",
	"2023-02-25T02:30:00.000Z",
	"2023-02-25T02:35:00.000Z",
	"2023-02-25T02:40:00.000Z",
	"2023-02-25T02:45:00.000Z",
	"2023-02-25T02:50:00.000Z",
	"2023-02-25T02:55:00.000Z"
]

{% endtab %}

{% tab title="400: Bad Request Fecha está en el pasado" %}

{
	"name": "BadRequest",
	"message": "The date can not be in the past.",
	"code": 400,
	"className": "bad-request",
	"data": "dateInPast",
	"errors": {}
}

{% endtab %}

{% tab title="400: Bad Request Fecha inválida" %}

{
	"name": "BadRequest",
	"message": "A valid \"date\" is required",
	"code": 400,
	"className": "bad-request",
	"data": "date",
	"errors": {}
}

{% endtab %}

{% tab title="400: Bad Request Zona horaria inválida" %}

{
	"name": "BadRequest",
	"message": "A valid \"timezone\" is required",
	"code": 400,
	"className": "bad-request",
	"data": "timezone",
	"errors": {}
}

{% endtab %}

{% tab title="401: Unauthorized API Key inválido" %} Referencia de errores en autorización. {% endtab %} {% endtabs %}

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

Name	Type	Description
id*	String	ID de servicio

Headers

Name	Type	Description
Authorization*	String	Bearer {token}
Content-Type*	String	application/json

Request Body

Name	Type	Description
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

{% tabs %} {% tab title="201: Created Hora agendada" %}

{
   "email":"john.doe@example.com",
   "service":"Service name",
   "startAt":"2023-02-01T03:00:00.000Z",
   "endAt":"2023-02-01T03:07:00.000Z",
   "duration":7,
   "timezone":"America/Santiago",
   "joinURL":"https://example.com?v-schedule-action=join&v-schedule-auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
   "rescheduleURL":"https://example.com?v-schedule-action=modify&v-schedule-auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
   "cancelURL":"https://example.com?v-schedule-action=modify&v-schedule-auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
   "accessToken":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
   "actionToken":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
   "message":"Your appointment was successfully scheduled."
}

{% endtab %}

{% tab title="400: Bad Request Zona horaria inválida" %}

{
	"name": "BadRequest",
	"message": "A valid \"timezone\" is required",
	"code": 400,
	"className": "bad-request",
	"data": "timezone",
	"errors": {}
}

{% endtab %}

{% tab title="400: Bad Request Fecha inválida" %}

{
	"name": "BadRequest",
	"message": "A valid \"date\" is required",
	"code": 400,
	"className": "bad-request",
	"data": "date",
	"errors": {}
}

{% endtab %}

{% tab title="409: Conflict Hora no disponible" %}

{
	"name": "Conflict",
	"message": "Sorry, the hour \"2023-02-07T03:56:00.000Z\" is unavailable.",
	"code": 409,
	"className": "conflict",
	"errors": {}
}

{% endtab %}

{% tab title="400: Bad Request Error en los campos de formulario" %}

{
	"name": "BadRequest",
	"message": "You reach the max characters is 50 for element \"60dbe3416af0be33b8b372b1\".",
	"code": 400,
	"className": "bad-request",
	"errors": {}
}

{
	"name": "BadRequest",
	"message": "Some element not as field, please check or try again",
	"code": 400,
	"className": "bad-request",
	"data": "Maybe the organization has changed the form and you're submit is not valid anymore.",
	"errors": {}
}

{% endtab %}

{% tab title="401: Unauthorized API Key inválido" %} Referencia de errores en autorización. {% endtab %} {% endtabs %}

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

Name	Type	Description
id*	String	ID del usuario

Headers

Name	Type	Description
Authorization*	String	Bearer {token}
Content-Type*	String	application/json

Request Body

Name	Type	Description
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

{% tabs %} {% tab title="400: Bad Request ID del servicio inválido" %}

{
	"name": "BadRequest",
	"message": "A valid service id is required",
	"code": 400,
	"className": "bad-request",
	"errors": {}
}

{% endtab %}

{% tab title="201: Created Hora agendada" %}

{
   "email":"john.doe@example.com",
   "service":"Service name",
   "startAt":"2023-02-01T03:00:00.000Z",
   "endAt":"2023-02-01T03:07:00.000Z",
   "duration":5,
   "timezone":"America/Santiago",
   "joinURL":"https://example.com?v-schedule-action=join&v-schedule-auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
   "rescheduleURL":"https://example.com?v-schedule-action=modify&v-schedule-auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
   "cancelURL":"https://example.com?v-schedule-action=modify&v-schedule-auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
   "accessToken":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
   "actionToken":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
   "message":"Your appointment was successfully scheduled."
}

{% endtab %}

{% tab title="409: Conflict Hora no disponible" %}

{
	"name": "Conflict",
	"message": "Sorry, the hour \"2023-02-07T04:24:00.000Z\" is unavailable.",
	"code": 409,
	"className": "conflict",
	"errors": {}
}

{% endtab %}

{% tab title="401: Unauthorized API Key invalido" %} Referencia de errores en autorización. {% endtab %}

{% tab title="400: Bad Request Fecha inválida" %}

{
	"name": "BadRequest",
	"message": "A valid \"date\" is required",
	"code": 400,
	"className": "bad-request",
	"data": "date",
	"errors": {}
}

{% endtab %}

{% tab title="400: Bad Request Zona horaria inválida" %}

{
	"name": "BadRequest",
	"message": "A valid \"timezone\" is required",
	"code": 400,
	"className": "bad-request",
	"data": "timezone",
	"errors": {}
}

{% endtab %}

{% tab title="400: Bad Request Error en los campos de formulario" %}

{
	"name": "BadRequest",
	"message": "You reach the max characters is 50 for element \"60dbe3416af0be33b8b372b1\".",
	"code": 400,
	"className": "bad-request",
	"errors": {}
}

{
	"name": "BadRequest",
	"message": "Some element not as field, please check or try again",
	"code": 400,
	"className": "bad-request",
	"data": "Maybe the organization has changed the form and you're submit is not valid anymore.",
	"errors": {}
}

{% endtab %} {% endtabs %}

Cancelar una hora

POST https://api.videsk.io/public/video-contact-center/schedule/cancel

Cancelar una hora usando actionToken

Headers

Name	Type	Description
Authorization*	String	Bearer {actionToken}
Content-Type*	String	application/json

Request Body

Name	Type	Description
cancelReason	String	Razón de cancelación

{% tabs %} {% tab title="201: Created Hora cancelada" %}

{
	"service": "Service name",
	"message": "The appointment was successfully canceled"
}

{% endtab %}

{% tab title="401: Unauthorized Error cancelado" %} Este error indica que la hora ya ha sido cancelada previamente, no es posible cancelar después del horario de inicio o ya ha finalizado.

{
	"name": "NotAuthenticated",
	"message": "The token is not valid any more.",
	"code": 401,
	"className": "not-authenticated",
	"errors": {}
}

{% endtab %}

{% tab title="401: Unauthorized Action token inválido" %} Referencia de errores en autorización. {% endtab %}

{% tab title="400: Bad Request Razón de cancelación inválido" %}

{
	"name": "BadRequest",
	"message": "Cast to string failed for value \"[]\" (type Array) at path \"cancelReason\"",
	"code": 400,
	"className": "bad-request",
	"errors": {}
}

{
	"name": "BadRequest",
	"message": "Validation failed: cancelReason: Path `cancelReason` (`...`) is longer than the maximum allowed length (1000).",
	"code": 400,
	"className": "bad-request",
	"errors": {}
}

{% endtab %} {% endtabs %}

Reagendar una hora

POST https://api.videsk.io/public/video-contact-center/schedule/reschedule

Reagendar una hora usando actionToken

Headers

Name	Type	Description
Authorization*	String	Bearer {actionToken}
Content-Type*	String	application/json

Request Body

Name	Type	Description
date*	Date	Fecha en formato ISO-8601

{% tabs %} {% tab title="201: Created Hora reagendada" %}

{
   "email":"john.doe@example.com",
   "service":"Service name",
   "startAt":"2023-02-01T03:00:00.000Z",
   "endAt":"2023-02-01T03:07:00.000Z",
   "duration":5,
   "timezone":"America/Santiago",
   "joinURL":"https://example.com?v-schedule-action=join&v-schedule-auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
   "rescheduleURL":"https://example.com?v-schedule-action=modify&v-schedule-auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
   "cancelURL":"https://example.com?v-schedule-action=modify&v-schedule-auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
   "accessToken":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
   "actionToken":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
   "message":"Your appointment was successfully scheduled."
}

{% endtab %}

{% tab title="401: Unauthorized Error reagendado" %} Este error indica que la hora ya ha sido reagendada previamente, no es posible reagendar después del horario de inicio o ya ha finalizado.

{
	"name": "NotAuthenticated",
	"message": "The token is not valid any more.",
	"code": 401,
	"className": "not-authenticated",
	"errors": {}
}

{% endtab %}

{% tab title="400: Bad Request Fecha inválida" %}

{
	"name": "BadRequest",
	"message": "A valid \"date\" is required",
	"code": 400,
	"className": "bad-request",
	"data": "date",
	"errors": {}
}

{% endtab %}

{% tab title="401: Unauthorized Action token inválido" %} Referencia de errores en autorización. {% endtab %} {% endtabs %}

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

Name	Type	Description
Authorization*	String	Bearer {accessToken}
Content-Type*	String	application/json

{% tabs %} {% tab title="201: Created Información de la hora" %}

{
   "id":"63be2378f0dd1fdbf86dac48",
   "service":{
      "id":"620fedcc8951823b744f3122",
      "title":"Service name",
      "description":"Service description"
   },
   "user":{
      "firstname":"Mark",
      "lastname":"Zuckerberg",
      "_id":"6179480f5aa331375394e6a9"
   },
   "startAt":"2023-02-07T05:13:00.000Z",
   "endAt":"2023-02-07T05:20:00.000Z",
   "status":"pending"
}

{% endtab %}

{% tab title="401: Unauthorized Action token inválido" %} Referencia de errores en autorización. {% endtab %}

{% tab title="401: Unauthorized Hora expirada" %} Este error se arroja cuando se intenta obtener información de una hora que ya ha sido cancelada, reagendada o ha finalizado.

{
	"name": "NotAuthenticated",
	"message": "The token is not valid any more.",
	"code": 401,
	"className": "not-authenticated",
	"errors": {}
}

{% endtab %} {% endtabs %}

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

calendario.md

calendario.md

Calendario

Obtener servicios de calendario

Headers

Obtener días del mes disponibles por id de servicio

Path Parameters

Query Parameters

Headers

Obtener horas del día disponibles por id de servicio

Path Parameters

Query Parameters

Headers

Obtener días del mes disponibles por id de usuario

Path Parameters

Query Parameters

Headers

Obtener horas del día disponibles por id de usuario

Path Parameters

Query Parameters

Headers

Agendar una hora por servicio

Path Parameters

Headers

Request Body

Agendar una hora por agente

Path Parameters

Headers

Request Body

Cancelar una hora

Headers

Request Body

Reagendar una hora

Headers

Request Body

Obtener información de una cita

Headers

Files

calendario.md

Latest commit

History

calendario.md

File metadata and controls

Calendario

Obtener servicios de calendario

Headers

Obtener días del mes disponibles por id de servicio

Path Parameters

Query Parameters

Headers

Obtener horas del día disponibles por id de servicio

Path Parameters

Query Parameters

Headers

Obtener días del mes disponibles por id de usuario

Path Parameters

Query Parameters

Headers

Obtener horas del día disponibles por id de usuario

Path Parameters

Query Parameters

Headers

Agendar una hora por servicio

Path Parameters

Headers

Request Body

Agendar una hora por agente

Path Parameters

Headers

Request Body

Cancelar una hora

Headers

Request Body

Reagendar una hora

Headers

Request Body

Obtener información de una cita

Headers