Ir para o final dos metadados
Ir para o início dos metadados

Você está vendo a versão antiga da página. Ver a versão atual.

Comparar com o atual Ver Histórico da Página

« Anterior Versão 2 Próxima »

Tópicos:

1- URL base API

AmbientesURL
Produção

https://api.mosia.chat

2- Endpoint

EndpointMétodoDescrição
videocall/prepare/register

POST

Método para iniciar um processo de preparo do Telecare

3- Autenticação

KeyValueDescriçã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âmetroObrigatórioTipoDescrição
datatrue
String

Data do agendamento no formato "AAAA-MM-DD".

especialidadeNome

true

String

Nome da especialidade do médico.

horatrue
String
Hora do agendamento no formato "HH:mm".
idAgendatrue
String
ID do agendamento.
localizadorMensageriatrue
String
Identificador do paciente.
pacienteCpftrue
String
Cpf do paciente.
pacienteEmailtrue
String
E-mail do paciente.
pacienteMatriculatrue
String
Matrícula do paciente.
pacienteNometrue
String
Nome do paciente.
profissionalNometrue
String
Nome do médico.
profissionalNumeroConselhotrue
String
Número do conselho do médico.
profissionalSiglaConselhotrue
String
Sigla do conselho do médico.
profissionalUfConselhotrue
String
UF do conselho do médico.
telefoneCelulartrue
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>"
}




  • Sem rótulos