Versões comparadas
comparado com
Chave
- Esta linha foi adicionada.
- Esta linha foi removida.
- A formatação mudou.
Tópicos:
Índice
1- URL base API
| Ambientes | URL |
|---|---|
| Produção |
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 |
| Data do agendamento no formato "AAAA-MM-DD". | especialidadeNome | true | bgcolor||||||||
| |||||||||||||
| String | Nome da especialidade do médico. | ||||||||||||
| hora | true |
| Hora do agendamento no formato "HH:mm". Se o intervalo entre data/hora atual e a data/hora da agenda for menor que prazo para o envio da ultima notificação, o pedido de preparo não será acatado. Neste caso, o paciente será recepcionado da forma tradicional, informando um numero de documento no ato da chamada do médico. | ||||||||||
especialidadeNome | true | Nome da especialidade do médico. | |||||||||||
| idAgenda | true |
| ID do agendamento. | ||||||||||
| localizadorMensageriaidentificadorUnico | true |
| Identificador único do paciente | ||||||||||
| pacienteCpf | true |
| Cpf do paciente. | ||||||||||
| pacienteEmail | true |
| E-mail do paciente. | ||||||||||
| pacienteMatricula | true |
| Matrícula do paciente. | ||||||||||
| pacienteNome | true |
| Nome do paciente. | ||||||||||
| telefoneCelular | true |
| Celular do paciente. | ||||||||||
| profissionalNome | true |
| Nome do médico. | ||||||||||
| profissionalNumeroConselho | true |
| Número do conselho do médico. | ||||||||||
| profissionalSiglaConselho | true |
| Sigla do conselho do médico. | ||||||||||
| profissionalUfConselho | true |
| UF do conselho do médico. | ||||||||||
| telefoneCelularprofissionalIdExterno | truefalse |
| Celular ID externo do paciente.médico |
4- Exemplo do request body
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"data": "2020-06-05",
"especialidadeNome": "Cardiologia",
"hora": "09:40",
"idAgenda": "10020",
"localizadorMensageriaidentificadorUnico": "100100500",
"pacienteCpf": "99999999999",
"pacienteEmail": "paciente@email.com.br",
"pacienteMatricula": "100100500",
"pacienteNome": "João dos Santos",
"telefoneCelular": "27999999999",
"profissionalNome": "Luiz Fernando",
"profissionalNumeroConselho": "11100",
"profissionalSiglaConselho": "CRM",
"profissionalUfConselho": "ES",
"telefoneCelularprofissionalIdExterno": "27999999999123"
} |
4- Exemplo de retorno API (Sucesso)
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"status": true,
"message": "<MENSAGEM>"
}
|
5- Exemplo de retorno API (Erro)
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"status": false,
"message": "<MENSAGEM>"
} |