Nuestras API permiten hasta 10 solicitudes por minuto. Para aumentar este límite, comuníquese con el soporte. Obtenga más información sobre los tiempos y límites de API. 

⚠️Atención: En la API de Tickets, después de 3 solicitudes con error, el código 429 - Too many failed requests será devuelto, bloqueando las solicitudes durante 60 segundos. Este tiempo queda tras 3 errores más consecutivos. El tiempo de espera está en el parámetro de retry-after posterior del header de respuesta será retornado, bloqueando requisições por 60 segundos.

https://api.movidesk.com/public/v1

Tickets

 URL:    /tickets
 Métodos: GET / POST / PATCH

Tickets/Past

 URL:    /tickets/past
 Métodos: GET

⚠️Atención: La ruta  /tickets trae los tickets con la fecha de actualización (lastupdate) menos de 90 días. Tickets que tengan una fecha de actualización anterior deben buscarse en la ruta /tickets/past. La cantidad máxima de devolución en una lista de tickets GET será de 100 tickets por página.

Layout

ticket

⚠️ Atención: Las API de soporte pueden tardar unos minutos en actualizar los tickets, los usuarios y otros registros, lo que puede provocar que no aparezcan inmediatamente en los resultados de búsqueda.

Tickets » Clientes

ticket.clients[n]

Tickets » Acciones

ticket.actions[n]

Tickets » Acciones » Hojas de tiempo

ticket.actions.timeAppointments[n]

Tickets » Acciones » Gastos

ticket.actions.expenses[n]

Tickets » Acciones » Adjuntos

ticket.actions.attachments[n]

Tickets » Tickets padres/niños

ticket.parentTickets[n]
ticket.childrenTickets[n]

Tickets » Historiales de responsabilidad

ticket.ownerHistories[n]

Tickets » Historiales de estado

ticket.statusHistories[n]

Tickets » Campos adicionales

ticket.customFieldValues[n]

*Observación: Solo los campos adicionales cuyas reglas de visualización se cumplan en el momento de la consulta se presentarán en la consulta de propiedad customFieldValues.

Tickets » Campos adicionales » Ítems

ticket.customFieldValues.items[n]

Person

ticket.clients[n].organization
ticket.actions[n].createdBy
ticket.actions[n].timeAppointments[n].createdBy
ticket.owner
ticket.createdBy
ticket.slaSolutionChangedBy

Team

ticket.actions[n].timeAppointments[n].createdByTeam

*UTC: La Hora Universal Coordinada es la zona horaria de referencia a partir de la cual se calculan todas las demás zonas horarias del mundo. Ej: si su zona horaria es Brasilia (UTC-03:00) y la hora actual son las 3:30 pm, la hora UTC será las 6:30 pm.

Todo el flujo de datos (Ver/Insertar/Cambiar) debe estar en formato JSON como se muestra en el siguiente ejemplo::

{ 
  "id":1,
  "protocol":"MOVI202109000001",
  "type":2,
  "subject":"Assunto",
  "category":"Categoria",
  "urgency":"Urgência",
  "status":"Status",
  "baseStatus":"Status base",
  "justification":"Justificativa",
  "origin":9,
  "createdDate":"2016-11-18T14:25:07.1920886",
  "originEmailAccount":"[email protected]",
  "owner":{ 
    "id":"CodRefDoResponsável",
    "personType":1,
    "profileType":1,
    "businessName":"Nome do responsável",
    "email":"[email protected]",
    "phone":"(47) 99999-9999"
  },
  "ownerTeam":"Equipe (do) responsável",
  "createdBy":{ 
    "id":"CodRefDoGeradorDoTicket",
    "personType":1,
    "profileType":2,
    "businessName":"Nome do gerador do ticket",
    "email":"[email protected]",
    "phone":"(47) 99999-9999"
  },
  "serviceFull":[ 
    "Serviço nível 1",
    "Serviço nível 2",
    "Serviço nível 3"
  ],
  "serviceFirstLevelId":1,
  "serviceFirstLevel":"Serviço nível 1",
  "serviceSecondLevel":"Serviço nível 2",
  "serviceThirdLevel":"Serviço nível 3",
  "contactForm":"Formulário de contato",
  "tags":[ 
    "Tag1",
    "Tag2",
    "Tag3"
  ],
  "cc":"[email protected],[email protected]",
  "resolvedIn":"2016-11-19T14:25:07.1920886",
  "reopenedIn":"2016-11-20T14:25:07.1920886",
  "closedIn":"2016-11-21T14:25:07.1920886",
  "lastActionDate":"2016-11-21T14:25:07.1920886",
  "actionCount":1,
  "lastUpdate":"2016-11-21T14:25:07.1920886",
  "lifeTimeWorkingTime":9999,
  "stoppedTime":9,
  "stoppedTimeWorkingTime":9,
  "resolvedInFirstCall":false,
  "chatWidget":"Chat - Exemplo",
  "chatGroup":"Grupo do Chat",
  "chatTalkTime":999,
  "chatWaitingTime":9,
  "sequence":2,
  "slaAgreement":"SLA Utilizado",
  "slaAgreementRule":"SLA Regra Utilizado",
  "slaSolutionTime":999,
  "slaResponseTime":99,
  "slaSolutionChangedByUser":false,
  "slaSolutionChangedBy":{ 
    "id":"CodRef",
    "personType":1,
    "profileType":3,
    "businessName":"Nome da pessoa que realizou a alteração",
    "email":"[email protected]",
    "phone":"(47) 99999-9999"
  },
  "slaSolutionDate":"2016-11-21T14:25:07.1920886",
  "slaSolutionDateIsPaused":false,
  "slaResponseDate":"2016-11-21T14:25:07.1920886",
  "slaRealResponseDate":"2016-11-21T14:25:07.1920886",
  "clients":[ 
    { 
      "id":"CodRefDoCliente",
      "personType":2,
      "profileType":2,
      "businessName":"Nome do cliente",
      "email":"[email protected]",
      "phone":"(47) 99999-9999",
      "isDeleted":false,
      "organization":{ 
        "id":"CodRefDaOrganização",
        "personType":1,
        "profileType":2,
        "businessName":"Nome da organização",
        "email":"[email protected]",
        "phone":"(47) 99999-9999"
      }
    }
  ],
  "actions":[ 
    { 
      "id":1,
      "type":2,
      "origin":9,
      "description":"Descrição da ação",
      "status":"Status",
      "justification":"Justificativa",
      "createdDate":"2016-11-21T14:25:07.1920886",
      "createdBy":{ 
        "id":"CodRefDoGeradorDaAção",
        "personType":1,
        "profileType":1,
        "businessName":"Nome do gerador da ação",
        "email":"[email protected]",
        "phone":"(47) 99999-9999"
      },
      "isDeleted":false,
      "timeAppointments":[ 
        { 
          "id":1,
          "activity":"Atividade do apontamento",
          "date":"2016-11-21T00:00:00",
          "periodStart":"21:32:13.7345254",
          "periodEnd":"21:39:08.3443985",
          "workTime":"00:06:54.6098731",
          "accountedTime":7.7666666666666666,
          "workTypeName":"Hora Extra",
          "createdBy":{ 
            "id":"CodRefDoGeradorDoApontamento",
            "personType":1,
            "profileType":1,
            "businessName":"Nome do gerador do apontamento",
            "email":"[email protected]",
            "phone":"(47) 99999-9999"
          },
          "createdByTeam":{ 
            "id":101,
            "name":"Qualidade"
          }
        }
      ],
      "expenses":[ 
        { 
          "id":12,
          "type":"Transporte",
          "serviceReport":"0",
          "createdBy":{ 
            "id":"9B7387E9-4C46-4BD0",
            "personType":1,
            "profileType":3,
            "businessName":"Administrador",
            "email":null,
            "phone":null,
            "address":null,
            "complement":null,
            "cep":null,
            "city":null,
            "bairro":null,
            "number":null,
            "reference":null
          },
          "createdByTeam":null,
          "date":"2018-11-05T18:22:00",
          "quantity":null,
          "value":145.11
        },
        { 
          "id":13,
          "type":"Alimentação",
          "serviceReport":"0",
          "createdBy":{ 
            "id":"9B7387E9-4C46-4BD0",
            "personType":1,
            "profileType":3,
            "businessName":"Administrador",
            "email":null,
            "phone":null,
            "address":null,
            "complement":null,
            "cep":null,
            "city":null,
            "bairro":null,
            "number":null,
            "reference":null
          },
          "createdByTeam":null,
          "date":"2018-11-05T18:22:00",
          "quantity":null,
          "value":25.33
        }
      ],
      "attachments":[ 
        { 
          "fileName":"minhaImagem.png",
          "path":"7BDEA1B62A8641FF86982D0CF9F3DEC0",
          "createdBy":{ 
            "id":"CodRefDeQuemEnviouOArquivo",
            "personType":1,
            "profileType":1,
            "businessName":"Nome de quem enviou o arquivo",
            "email":"[email protected]",
            "phone":"(47) 99999-9999"
          },
          "createdDate":"2017-05-29T14:19:50.0129141"
        }
      ],
      "parentTickets":[ 
        { 
          "id":2,
          "subject":"Assunto do ticket pai",
          "isDeleted":false
        }
      ],
      "childrenTickets":[ 
        { 
          "id":3,
          "subject":"Assunto do ticket filho",
          "isDeleted":false
        }
      ],
      "satisfactionSurveyResponses":[ 
        { 
          "id":1,
          "responsedBy":{ 
            "id":"CodRefDeQuemRespondeuAPesquisa",
            "personType":1,
            "profileType":2,
            "businessName":"Nome de quem respondeu a pesquisa",
            "email":"[email protected]",
            "phone":"(47) 99999-9999"
          },
          "responseDate":"2016-11-22T14:25:07.1920886",
          "satisfactionSurveyModel":2,
          "satisfactionSurveyNetPromoterScoreResponse":null,
          "satisfactionSurveyPositiveNegativeResponse":null,
          "satisfactionSurveySmileyFacesResponse":5,
          "comments":"Comentário na resposta da pesquisa"
        }
      ],
      "customFieldValues":[ 
        { 
          "customFieldId":3,
          "customFieldRuleId":2,
          "line":1,
          "value":null,
          "items":[ 
            { 
              "personId":null,
              "clientId":null,
              "team":null,
              "customFieldItem":"um"
            }
          ]
        },
        { 
          "customFieldId":1,
          "customFieldRuleId":1,
          "line":1,
          "value":"texto via api",
          "items":[ 

          ]
        }
      ]
    }
  ]
}

Obtener un único ticket

⚠️Atención: Lista o Array: Las variables de tipo lista ou “array” solo se presentarán en la consulta de tipo “ticket individual”, según el ejemplo siguiente, y no se mostrarán en la devolución de consulta de tipo “lista de tickets”.

GET: /tickets
Parâmetros: id / protocol, token

Ejemplo:

Obteniendo o ticket con id 1

GET: https://api.movidesk.com/public/servir/v1/tickets?token=52ee6ca5-8639-422b-bafe-470013c11176&id=1

Retorno:

  {
    "id": 1,
    "protocol":"MOVI202109000001",
    "type": 2,
    "origin": 0,
    "status": "Novo",
    "justification": null,
    ... Demais colunas no formato do layout acima
  }

Obteniendo el ticket con protocolo MOVI202109000001

GET: https://api.movidesk.com/public/v1/tickets?token=52ee6ca5-8639-422b-bafe-470013c11176&protocol=MOVI202109000001

Retorno:

 {
    "id": 1,
    "protocol":"MOVI202109000001",
    "type": 2,
    "origin": 0,
    "status": "Novo",
    "justification": null,
    ... Demais colunas no formato do layout acima
  }

⚠️ Atención: Campos adicionales: solo los campos adicionales cuyas reglas de visualización se cumplan en el momento de la consulta se presentarán en la consulta de propiedad customFieldValues.

Obteniendo una lista de tickets

⚠️ Atención: Lista o Array: Las variables de tipo lista ou “array” solo se presentarán en la consulta de tipo “ticket individual”, según el ejemplo siguiente, y no se mostrarán en la devolución de consulta de tipo “lista de tickets”.

GET: /tickets
Parâmetros: token, (LastUpdate y/o CreatedDate i/o Status)
Ejemplo:

Obteniendo una lista de tickets (es obligatorio utilizar un filtro)

GET: https://api.movidesk.com/public/servir/v1/tickets?token=52ee6ca5-8639-422b-bafe-470013c11176&status=Novo

Retorno:

  [
    {
      "id": 1,
      "type": 2,
      "origin": 0,
      "status": "Novo"
    },
    {
      "id": 2,
      "type": 2,
      "origin": 0,
      "status": "Novo"
    }
    ... Demais itens da lista 
  ]

Paginación de la lista de tickets

GET: /tickets
Parâmetros: token, (Page y/o Size)

⚠️ Atención: La lista se paginará con una cantidad. máximo 100 registros por páginay la paginación se pueden utilizar con los siguientes recursos:

Page: ID de la página buscada (La primera página será la número 0 por defecto y debería ser la página predeterminada que se mostrará si la búsqueda no tiene filtros de paginación).

Size: Número de artículos que se devolverán (Máximo 100 artículos y si se agrega un valor mayor, se descartará y solo se mostrarán 100 artículos).

GET: https://api.movidesk.com/public/servir/v1/tickets?token=52ee6ca5-8639-422b-bafe-470013c11176&status=Novo&page=0&size=100

Retorno:

[
    {
      "id": 1,
      "type": 2,
      "origin": 0,
      "status": "Novo"
    },
    {
      "id": 2,
      "type": 2,
      "origin": 0,
      "status": "Novo"
    }
    ... Demais itens da lista 
  ]

GET: /tickets
Parâmetros: token

Headers: Content-Type: application/json

Corpo do post: {objeto JSON}

Ejemplo:

POST: https://api.movidesk.com/public/v1/tickets?token=52ee6ca5-8639-422b-bafe-470013c11176&returnAllProperties=false
Headers: Content-Type: application/json
RequestBody:
{  
 "type": 2,
 "subject": "Assunto",
 "category": "Categoria",
 "urgency": "Urgência",
 "status": "Status",
 "justification": "Justificativa",
 "createdDate": "2016-11-18T14:25:07.1920886",
  ... Demais colunas no formato do layout acima
}

Retorno: Status 200 y en el corpo el id (número) del ticket ingresado.

A diferencia de la inserción de datos (POST), la actualización se realiza parcialmente. Por lo tanto, es necesario enviar sólo los datos que desea cambiar al servidor.

⚠️ Atenção: Al cambiar listas (objetos secundarios) siempre se reemplazan todos los elementos de la lista.

En las listas de acciones y notas se debe ingresar el Id en el cuerpo para indicar cambios, porque cuando el Id no es informado (es igual a cero) las acciones y notas se insertarán y no se modificarán. Los clientes y notas que no estén incluidos en el cuerpo serán excluidos de las listas de clientes y notas..

PATCH: /tickets
Parâmetros: token, id

Headers: Content-Type: application/json

Corpo do post: {objeto JSON}

Ejemplos:

Cambiar el asunto del ticket con id (número de ticket) 1

PATCH: https://api.movidesk.com/public/v1/tickets?token=52ee6ca5-8639-422b-bafe-470013c11176&id=1
Headers: Content-Type: application/json
RequestBody:
{
  "subject": "Movidesk"
}

Retorno: Status 200

En el ejemplo anterior, solo se cambia el campo subject, los demás campos permanecen sin cambios.

Eliminación de etiquetas de boletos con identificación (número de boleto) 1

PATCH: https://api.movidesk.com/public/v1/tickets?token=52ee6ca5-8639-422b-bafe-470013c11176&id=1
Headers: Content-Type: application/json
RequestBody:
{
  "tags": []
}

Retorno: Status 200

Dado que las etiquetas están en una lista, en el ejemplo anterior, se eliminarán todas las etiquetas. Porque los valores ingresados en la lista siempre sobrescriben los valores registrados anteriormente.

Adjuntos

 URL:    /ticketFileUpload
 Método: POST

Layout

POST: /ticketFileUpload
Parâmetros: token, id e action Id

Headers: Content-Type: multipart/form-data

Corpo do post: anexos

Ejemplo:

POST: https://api.movidesk.com/public/v1/ticketFileUpload?token=52ee6ca5-8639-422b-bafe-470013c11176&id=1452&actionId=1
Headers: Content-Type: multipart/form-data
RequestBody: anexos

Retorno: Status 200y y en el cuerpo los detalles de los archivos adjuntos insertados (nombres de archivos, hashes y posibles errores).