Hola, ¿cómo podemos ayudarte?

  1. Consola principal
  2. Volver a la búsqueda
  3. 05. Integraciones
  4. API's
API de Movidesk - Actividades
6 min
Creado por Movidesk en 02/07/2019 16:26
Actualizado por Karine Moreira en 24/09/2024 16:26
Importante: Nuestras API's tienen un límite de 10 solicitudes por minuto para garantizar un comportamiento saludable en su uso. Si tienes un escenario específico que requiera aumentar el uso, contacta con nuestro equipo de soporte para analizar la viabilidad. Obtén más información sobre horarios y límites de las API's
https://api.movidesk.com/public/v1

Esta API puede ser utilizada junto con la API de contrato de horas.

Actividades

URL: /activity
Métodos: GET / POST / PATCH / DELETE
Propiedad Tipo Tamaño Obligatorio Descripción
Id int     Código de referencia de la actividad.
activityDto activityDto     Objeto que contiene los campos de la actividad creada.
data activityDto     Los campos que se modificarán en la actividad.

 

activityDto

Propiedad Tipo Tamaño Obligatorio Descripción
Id int     Código de referencia de la actividad (solo lectura).
Name string 128 ✓ Nombre de la actividad.
IsActive bool     Si la actividad está o no activa.
IsAllowsAllTeams bool     Si la actividad está disponible para todos los equipos.
Teams array   *

*Obligatorio cuando IsAllowsAllTeams=false

No se permiten equipos con nombres ya existentes.

 

URL: /addTeamsToActivity
Métodos: POST
Propiedad Tipo Tamaño Obligatorio Descripción
activityId int     Código de referencia de la actividad.
teams array     Equipos.

 

Método GET

GET: /activity

Parámetros: id, token

Ejemplo: Obteniendo la actividad con el id 1

GET: https://api.movidesk.com/public/v1/activity?token=c4f511ca-83e5-4155-9d01-325fa3ab3738&id=1

Retorno:

{
    "id": 1,
    "name": "Teste 3",
    "isActive": true,
    "isAllowsAllTeams": false,
    "teams":
    [
        {
            "name": "Administradores"
        }
    ]
}

 

Obteniendo actividades con paginación:

GET: /activity/

Parámetros: token

Parámetro opcional: limit, startingAfter, name

Parámetros:

limit Un límite en el número de objetos a ser devueltos, entre 1 y 100. (predeterminado: 100)
startingAfter Un cursor para uso en la paginación. startingAfter es un ID de objeto que define su lugar en la lista. Por ejemplo, si haces una solicitud y recibes 100 objetos, terminando con 100, en tu llamada subsiguiente puedes incluir el parámetro startingAfter=100 para buscar la siguiente página. (opcional)
name Nombre de la actividad
Retorno:
hasMore Si hay o no más elementos disponibles después de este conjunto. Si false, se entiende como el final de la lista.
items Un array que contiene las actividades de la página actual.

Ejemplo: Obteniendo un límite de tres actividades que contengan "Actividad" en el nombre

GET: https://api.movidesk.com/public/v1/activity?token=2A1D2F6C-0AF0-440C-A743-AF7910BEA185&limit=3&name=actividad

Retorno:

{
 "hasMore": true,
 "items": [
 {
 "id": 371,
 "name": "Actividad número dos",
 "isActive": true,
 "isAllowsAllTeams": false,
 "teams": [
 {
 "name": "Comercial"
 },
 {
 "name": "Desarrollo / Mantenimiento"
 }
 ]
 },
 {
 "id": 370,
 "name": "Actividad",
 "isActive": true,
 "isAllowsAllTeams": true,
 "teams": []
 },
 {
 "id": 369,
 "name": "Actividad número tres",
 "isActive": true,
 "isAllowsAllTeams": true,
 "teams": []
 }
 ]
}

 

Método POST

POST: /activity

Parámetros: token

Headers: Content-Type: application/json

Cuerpo del post: {objeto JSON}

Ejemplo:

POST: http://api.movidesk.com/public/v1/activity?token=c4f511ca-83e5-4155-9d01-325fa3ab3738

Headers: Content-Type: application/json
RequestBody:
{
"name": "actividad",
"isActive": true,
"isAllowsAllTeams": false,
"teams":
[
{
"name": "Administradores"
},
{
"name": "Soporte"
}
]
}
 
Retorno: Status 200 y el id de la actividad creada

Método PATCH

PATCH: /activity

Parámetros: id, token

Headers: Content-Type: application/json

Cuerpo del post: {objeto JSON}

Ejemplo: Cambiando el nombre y los equipos de la actividad con el id 1

POST: http://api.movidesk.com/public/v1/activity?token=c4f511ca-83e5-4155-9d01-325fa3ab3738&id=1

RequestBody:
{
"name": "actividad modificada",
 
"teams":
[
{
"name": "Equipo"
}
]
}
 
Retorno: Status 200 y el id de la actividad modificada

Método DELETE

DELETE: /activity

Parámetros: id, token

Ejemplo: Eliminando la actividad con id 1

DELETE: http://api.movidesk.com/public/v1/activity?token=c4f511ca-83e5-4155-9d01-325fa3ab3738&id=1

Retorno: Status 200 y el id de la actividad eliminada

 

Método POST

POST: /addTeamsToActivity

Parámetros: activityId, token

Headers: Content-Type: application/json

Cuerpo del post: {objeto JSON}

Ejemplo: agregando el equipo "Soporte" a la actividad con id 1

POST: http://api.movidesk.com/public/v1/addTeamsToActivity?token=155cac97-f203-4bb8-86e1-aa4cb8781f3e&activityId=380

RequestBody:
[
"Soporte"
]
 
Retorno: Status 200 y un array con todos los equipos de la actividad modificada después de agregar los equipos