Cancelar Agenda

1- URL base API

Ambientes	URL

Ambientes	URL
Produção	https://api.mosia.chat/v1
Homologação	https://api.hmg.mosia.chat/v1

2- Endpoint

Endpoint	Método	Descrição

Endpoint	Método	Descrição
schedule/cancel	POST	Método cancela uma agenda de acordo com os parâmetros de entrada.

3- Headers

Campo	Obrigatório	Tipo	Descrição

Campo	Obrigatório	Tipo	Descrição
`Authorization`	TRUE	string	Token de autenticação pode ser encontrado na página de configuração de integração com CRM no painel administrativo.
`id_operadora`	FALSE	inteiro	Código de integração da operadora na Mobile Saúde

Para obter o TOKEN_API_MOSIA relacionado ao CRM. siga os passos:

Acesse a administração do MOSIA, em admin.mosia.chat
No menu principal, acesse "Ajustes Gerais" e habilite o CRM;
Indique uma URL de CALLBACK e salve as mudanças.
Um token será exibido. Este é o token que será utilizado nas integrações destas APIs.

4- Parâmetros envio

Parâmetro	Obrigatório	Tipo	Descrição

Parâmetro	Obrigatório	Tipo	Descrição
`idAgendaIntegracao`	TRUE	string	ID da agenda (Sistema do cliente)
`idChaveUnicaPaciente`	TRUE	string	Chave única do paciente
`idChaveUnicaProfissional`	TRUE	string	ID do médico (Sistema do cliente)
`camposPersonalizados`	FALSE	array	Array de objetos contendo chave e valor dos campos personalizados. Este campos serão exibidos no emails de cancelamento de agenda.
`bloquearNotificacao`	FALSE	boolean	O valor default é “false”. Quando houver a necessidade de não enviar notificação de cancelamento para o beneficiário, deve ser passado true neste parâmetro.

5- Body request

{
  "idAgendaIntegracao": "200",
  "idChaveUnicaPaciente": "paciente@email.com.br",
  "idChaveUnicaProfissional" : "919191",
  "camposPersonalizados": [
      {
          "chave": "Teste cancelamento",
          "valor": "Valor teste cancelamento"
      },
      {
          "chave": "Teste cancelamento 2",
          "valor": "Valor teste cancelamento 2"
      }
  ],
  "bloquearNotificacao": false
}

6- Retorno com sucesso (200)

{
    "status": true,
    "data": {},
    "critical": null,
    "timestamp": "2021-01-19T16:43:56.256Z",
    "msg": "Agenda cancelada com sucesso."
}

7- Retorno com erro (200)

{
    "status": false,
    "data": {},
    "critical": [
        {
            "COD": 0,
            "DESC": "A propriedade [idAgenda] é obrigatória.",
            "origem": "",
            "trace": "",
            "SOLU": null,
            "REAL": null,
            "CONT": null
        }
    ],
    "timestamp": "2021-01-19T16:44:42.868Z",
    "msg": "A propriedade [idAgenda] é obrigatória."
}