Iniciar Preparo

Tópicos:

1- URL base API

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

2- Endpoint

Endpoint	Método	Descrição
videocall/prepare/register	POST	Método para iniciar um processo de preparo do Telecare

3- Autenticação

Key	Value	Descrição
Authorization	<TOKEN_API_MOSIA>	Token de autenticação pode ser encontrado na página de configuração de integração com CRM no painel administrativo.

3- Request Body (JSON)

Parâmetro	Obrigatório	Tipo	Descrição
data	true	String	Data do agendamento no formato "AAAA-MM-DD".
especialidadeNome	true	String	Nome da especialidade do médico.
hora	true	String	Hora do agendamento no formato "HH:mm".
idAgenda	true	String	ID do agendamento.
identificadorUnico	true	String	Identificador único do paciente
pacienteCpf	true	String	Cpf do paciente.
pacienteEmail	true	String	E-mail do paciente.
pacienteMatricula	true	String	Matrícula do paciente.
pacienteNome	true	String	Nome do paciente.
profissionalNome	true	String	Nome do médico.
profissionalNumeroConselho	true	String	Número do conselho do médico.
profissionalSiglaConselho	true	String	Sigla do conselho do médico.
profissionalUfConselho	true	String	UF do conselho do médico.
telefoneCelular	true	String	Celular do paciente.

4- Exemplo do request body

Retorno API sucesso

{
  "data": "2020-06-05",
  "especialidadeNome": "Cardiologia",
  "hora": "09:40",
  "idAgenda": "10020",
  "localizadorMensageria": "100100500",
  "pacienteCpf": "99999999999",
  "pacienteEmail": "paciente@email.com.br",
  "pacienteMatricula": "100100500",
  "pacienteNome": "João dos Santos",
  "profissionalNome": "Luiz Fernando",
  "profissionalNumeroConselho": "11100",
  "profissionalSiglaConselho": "CRM",
  "profissionalUfConselho": "ES",
  "telefoneCelular": "27999999999"
}

4- Exemplo de retorno API (Sucesso)

Retorno API sucesso

{
    "status": true,
    "message": "<MENSAGEM>"
}

5- Exemplo de retorno API (Erro)

Retorno API falha

{
    "status": false,
    "message": "<MENSAGEM>"
}