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

Tickets

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

Layout

ticket

Tickets » Clientes

ticket.clients[n]

Tickets » Ações

ticket.actions[n]

Tickets » Ações » Apontamentos de horas

ticket.actions.timeAppointments[n]

Tickets » Ações » Despesas

ticket.actions.expenses[n]

Tickets » Ações » Anexos

ticket.actions.attachments[n]

Tickets » Tickets Pais/Filhos

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


Tickets » Históricos de responsabilidades

ticket.ownerHistories[n]

Tickets » Históricos de status

ticket.statusHistories[n]

Tickets » Respostas de satisfação

ticket.satisfactionSurveyResponses[n]

Tickets » Campos adicionais

ticket.customFieldValues[n]

  *Observação: Serão apresentadas na consulta da propriedade customFieldValues apenas campos adicionais que estiverem com suas regras de exibição sendo atingidas no momento da consulta.

Tickets » Campos adicionais » Itens

ticket.customFieldValues.items[n]

Tickets » Ativos

ticket.assets[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: O Tempo Universal Coordenado (do inglês Universal Time Coordinated) é o fuso horário de referência a partir do qual se calculam todas as outras zonas horárias do mundo. Ex: Se o seu fuso horário for o de Brasília (UTC-03:00) e o horário atual for 15h30, o horário UTC será 18h30.

Todo o fluxo de dados (Visualização/Inserção/Alteração) devem possuir o formato JSON conforme exemplo abaixo:

{ 
  "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@origem.com",
  "owner":{ 
    "id":"CodRefDoResponsável",
    "personType":1,
    "profileType":1,
    "businessName":"Nome do responsável",
    "email":"email@responsavel.com",
    "phone":"(47) 99999-9999"
  },
  "ownerTeam":"Equipe (do) responsável",
  "createdBy":{ 
    "id":"CodRefDoGeradorDoTicket",
    "personType":1,
    "profileType":2,
    "businessName":"Nome do gerador do ticket",
    "email":"email@gerador.com",
    "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@cc.com.br,email2@cc.com.br",
  "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@email.com",
    "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@client.com",
      "phone":"(47) 99999-9999",
      "isDeleted":false,
      "organization":{ 
        "id":"CodRefDaOrganização",
        "personType":1,
        "profileType":2,
        "businessName":"Nome da organização",
        "email":"email@organizacao.com",
        "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@gerador.com",
        "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@gerador.com",
            "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@pessoa.com",
            "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@quemrespondeu.com",
            "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":[ 

          ]
        }
      ]
    }
  ]
}

Obtendo um único ticket

GET: /tickets
Parâmetros: id / protocol, token
Parâmetro opcional (o valor padrão é falso): includeDeletedItems (caso verdadeiro retornará ações, clientes, tickets pais e tickets filhos que foram associados ao ticket e deletados)

Exemplo:

Obtendo o ticket com o id 1

GET: https://api.movidesk.com/public/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
  }

Obtendo o ticket com o 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
  }

  *Campos adicionais: Serão apresentadas na consulta da propriedade customFieldValues apenas campos adicionais que estiverem com suas regras de exibição sendo atingidas no momento da consulta.

Obtendo o HTML das ações de um ticket

GET: /tickets/htmldescription
Parâmetros: id / protocol, token
Parâmetro opcional (o valor padrão é falso): id da action

Exemplo:

Obtendo o HTML da primeira action de um ticket com o id 1

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

Retorno:

  {
"id": 1,
"description": “<h1>title</h1></br><p>some text from action</p>”
}

Obtendo uma lista de tickets

GET: /tickets
Parametros: token, $select
Parâmetro opcional (o valor padrão é falso): includeDeletedItems (caso verdadeiro retornará ações, clientes, tickets pais e tickets filhos que foram associados ao ticket e deletados)
Exemplo:

Obtendo uma lista de tickets (é obrigatório o uso da cláusula $select)

GET: https://api.movidesk.com/public/v1/tickets?token=52ee6ca5-8639-422b-bafe-470013c11176&$select=id,type,origin,status

Retorno:

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

Obtendo tickets com filtros

GET: /tickets
Parâmetros: token, $select

Para permitir e simplificar consultas com filtros, a API utiliza o protocolo aberto OData. Os filtros possíveis são:
• $filter: a expressão especificada com esse filtro é avaliada para cada item do retorno da consulta e somente os itens em que o resultado da expressão for verdadeiro serão incluídos no retorno final;
• $orderby: permite que os itens do retorno da consulta sejam ordenados de forma ascendente (asc) ou descendente (desc). Se não for especificado asc ou desc, o padrão será asc;
• $top: permite especificar o número de itens que devem ser incluídos no retorno da consulta;
• $skip: permite especificar a quantidade de itens que devem ser ignorados e não incluídos no retorno da consulta;
• $select: permite especificar propriedades especificas dos itens que devem ser preenchidas no retorno da consulta;
• $expand: permite expandir as coleções filhas dos itens consultados.

Exemplos:

Obtendo o id, o assunto e a data de criação dos tickets que possuam a data de criação maior do que 01-09-2016:

GET: https://api.movidesk.com/public/v1/tickets?token=52ee6ca5-8639-422b-bafe-470013c11176&$select=id,subject,createdDate&$filter=createdDate gt 2016-09-01T00:00:00.00z


Retorno:

[
  {
   "createdDate": "2016-09-05T14:27:58.9565653",
   "subject": "Ticket 1 criado após 01-09-2016",
   "id": 1
 },
 {
   "createdDate": "2016-09-06T14:30:06.4217688",
   "subject": "Ticket 2 criado após 01-09-2016",
   "id": 2
 },
    ... Demais itens da lista que possuam a data de criação maior do que 01-09-2016
]

Obtendo o id, o assunto e a data de criação dos tickets que possuam a data de criação maior do que 01-09-2016 e ordenados de forma descendente em relação ao id:

GET: https://api.movidesk.com/public/v1/tickets?token=52ee6ca5-8639-422b-bafe-470013c11176&$select=id,subject,createdDate&$filter=createdDate gt 2016-09-01T00:00:00.00z&$orderby=id desc

Retorno:

[
  {
   "createdDate": "2016-11-06T14:27:58.9565653",
   "subject": "Ticket 399 criado após 01-09-2016",
   "id": 399
 },
 {
   "createdDate": "2016-11-05T14:30:06.4217688",
   "subject": "Ticket 398 criado após 01-09-2016",
   "id": 398
 },
    ... Demais itens da lista que possuam a data de criação maior do que 01-09-2016 e ordenados de forma descendente em relação ao id
]

Obtendo o id, o assunto e a data de criação dos tickets que possuam a data de criação maior do que 01-09-2016, ordenados de forma descendente em relação ao id e filtrando o retorno para obter apenas 100 tickets, mas pulando os primeiros 100 (utilizado para paginação do retorno, no caso para obter a segunda página):

GET: https://api.movidesk.com/public/v1/tickets?token=52ee6ca5-8639-422b-bafe-470013c11176&$select=id,subject,createdDate&$filter=createdDate gt 2016-09-01T00:00:00.00z&$orderby=id desc&$top=100&$skip=100

Retorno:

[
  {
   "createdDate": "2016-10-06T14:27:58.9565653",
   "subject": "Ticket 299 criado após 01-09-2016",
   "id": 299
 },
 {
   "createdDate": "2016-10-05T14:30:06.4217688",
   "subject": "Ticket 298 criado após 01-09-2016",
   "id": 298
 },
    ... Demais 98 itens da lista que possuam a data de criação maior do que 01-09-2016, ordenados de forma descendente em relação ao id
]

 
Obtendo o id, o assunto e a data de criação dos tickets que possuam a data de criação entre 10-10-2016 e 17-10-2016, expandindo o responsável, as ações (obtendo apenas a origem e o id), os apontamentos das ações e o geradores dos apontamentos.

GET: https://api.movidesk.com/public/v1/tickets?token=52ee6ca5-8639-422b-bafe-470013c11176&$select=id,subject,createdDate&$filter=createdDate ge 2016-10-10T00:00:00.00z and createdDate le 2016-10-17T00:00:00.00z&$expand=owner,actions($select=origin,id),actions($expand=timeAppointments($expand=createdBy))


Retorno:

[
 {
  "createdDate": "2016-10-12T21:25:58.2142783",
  "subject": "Ticket que se encaixa nos filtros do exemplo",
  "id": 291,
  "actions": [   
   {
   "id": 1,
   "origin": 9,
   "timeAppointments": [
    {
    "createdBy": {
    "id": "CodRefDoGerador",
    "personType": 1,
    "profileType": 3,
    "businessName": "Nome do gerador",
    "email": "email@gerador.com",
    "phone": "(47) 99999-9999"
     },
    "id": 1,
    "activity": "Atividade do apontamento",
    "date": "2016-10-12T00:00:00",
    "periodStart": "21:26:00",
    "periodEnd": "21:27:00",
    "workTime": "00:01:00",
    "accountedTime":7.7666666666666666,
    "workType": 2
    }
   ]
  }
 ],
  "owner": {
  "id": "CodRefDoResponsavel",
  "personType": 1,
  "profileType": 3,
  "businessName": "Nome do responsável",
  "email": "email@responsavel.com",
  "phone": "(47) 99999-9999"
  }
 }
]

Obtendo o id e clientes dos tickets onde qualquer cliente possua o id igual a 1:

GET: https://api.movidesk.com/public/v1/tickets?token=52ee6ca5-8639-422b-bafe-470013c11176&$filter=clients/any(client: client/id eq '1')&$select=id&$expand=clients

Retorno:

[
  {   
   "id": 302,
   "clients": [
   {
    "id": "1",
    "personType": 2,
    "profileType": 2,
    "businessName": "Nome do cliente",
    "email": "email@client.com",
    "phone": "(47) 99999-9999",
    "isDeleted": false,
    "organization": 
    {
     "id": "CodRefDaOrganização",
     "personType": 1,
     "profileType": 2,
     "businessName": "Nome da organização",
     "email": "email@organizacao.com",
     "phone": "(47) 99999-9999"
    }
  }],
 },
 {  
   "id": 504,
   "clients": [
   {
    "id": "1",
    "personType": 2,
    "profileType": 2,
    "businessName": "Nome do cliente",
    "email": "email@client.com",
    "phone": "(47) 99999-9999",
    "isDeleted": false,
    "organization": 
    {
     "id": "CodRefDaOrganização",
     "personType": 1,
     "profileType": 2,
     "businessName": "Nome da organização",
     "email": "email@organizacao.com",
     "phone": "(47) 99999-9999"
    }
  }],
 },
    ... Demais itens da lista que possuam a clientes com o id igual a 1
]

POST: /tickets
Parametros: token, returnAllProperties (valor default é false)
Headers: Content-Type: application/json
Corpo do post: {objeto JSON}

Exemplo:

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 e no corpo o id (número) do ticket inserido.

Diferentemente da inserção de dados (POST) a atualização é efetuada de forma parcial. Sendo assim é necessário enviar ao servidor somente os dados que se deseja alterar.
Entretanto a alteração das listas (objetos filhos) sempre sobrescreve todos os itens da lista.

Nas listas de ações e apontamentos deve ser informado o Id no corpo para indicar alteração, pois quando o Id não for informado (for igual a zero) as ações e apontamentos
serão inseridos e não alterados. Nas listas de clientes e apontamentos serão excluídos os clientes e apontamentos que não forem informados no corpo.

PATCH: /tickets
Parâmetros: token, id
Headers: Content-Type: application/json
Corpo: {objeto JSON}

Exemplos:

Alterando o assunto do ticket com id (número do 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

No exemplo acima, é alterado somente o campo subject, os demais campos permanecem inalterados

Removendo as tags do ticket com id (número do ticket) 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

Como as tags estão em uma lista, no exemplo acima, todos as tags serão removidas. Pois os valores informados na lista sempre sobrescrevem os valores previamente gravados.

Anexos

  URL:    /ticketFileUpload
  Método: POST 

Layout

POST: /ticketFileUpload
Parametros: token, id e actionId
Headers: Content-Type: multipart/form-data
Corpo do post: anexos

Exemplo:

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 200 e no corpo os detalhes dos anexos inseridos (nome dos arquivos, hashes e possíveis erros)

try
{
   var ticket = new
   {
     subject = "Novo ticket"
   };
   var json = JsonConvert.SerializeObject(ticket);

   var response = await SendAsync("https://api.movidesk.com/public/v1/tickets?token=SEUTOKEN",
   json, "POST", "application/json"); 
}
catch (WebException ex)
{
   var response = new StreamReader(ex.Response.GetResponseStream()).ReadToEnd();
}

public static async Task<string> SendAsync(string uri, string content, string method, string contentType)
{
  var req = WebRequest.Create(uri);
  req.ContentType = contentType;
  req.Method = method;

  using (var stream = await req.GetRequestStreamAsync())
  using (var streamWriter = new StreamWriter(stream))
  {
    await streamWriter.WriteAsync(content);
  }

  var httpResponse = (HttpWebResponse)await req.GetResponseAsync();
  using (var stream = httpResponse.GetResponseStream())
  {
    if (stream == null)
       return null;

    using (var streamReader = new StreamReader(stream))
    { 
       return await streamReader.ReadToEndAsync();
    }
  }
}