Regras de negócio

Cria uma nova meeting com os dados passados no body.

End-Point

Endpoint

Método

Header Content-Type

Descrição

https://api.mosiaomnichannel.com.br/clientes/meetings/criar

POST

application/json

Atualização de posição na fila

Headers

Parâmetro

Obrigatório

Tipo

Descrição

Authorization

M

token do cliente

Token de autenticação do cliente.

Clique aqui para ler a documentação sobre como obter o token de autenticação

instancia_aplicacao

OP

Sandbox = 1
Production = 2

Tipo de instância
Padrão: 2

content-type

M

application/json

Tipo de Conteúdo enviado para a requisição

Parametros de entrada

Serão enviados no BODY os seguintes parâmetros:

Parâmetro

Obrigatório

Tipo

Descrição

chaveUnica

M

String

Identifica o usuário que realizou o agendamento

responsavelAtendimento

M

Object

Identifica o contato para qual o sistema deve realizar a ligação.

paciente

M

Objeto

Identifica o paciente selecionado para agendamento da consulta

identificadorExterno*

M

String

ID de integração externa da meeting

tipoMeeting

M

Number

Enum de tipos:

1 = Consulta Eletiva

2 = Pronto Atendimento

idFuncionalidade

OP

Int

ID da funcionalidade

canal

OP

String

Canal de atendimento

customData

OP

Object

Payload enviado na consulta

Observações:

Objeto responsavelAtendimento [M]

Parâmetro

Obrigatório

Tipo

Descrição

nome

M

String

Nome do responsável pelo atendimento

chaveUnica

M

String

chaveUnica do responsável pelo atendimento

Objeto paciente [M]

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

chaveUnica

M

String

Chave de identificação do paciente

 

numeroContrato

M

String

Número do contrato do paciente

 

Objeto customData [OP]

Todo o body de envio do endpoint de criação de consulta: https://mobilesaudejira.atlassian.net/wiki/spaces/FAC/pages/2315517953/Gravar+consulta#Endpoint

Ex:

{
  "chaveUnica":"101012",
  "integracao":{
    "xpto":"voluptatibus",
    "xyz":"quibusdam",
    "abcdef":9288701
  },
  "tipoAgenda":"1",
  "paciente":{
    "chaveUnica":"101012",
    "numeroContrato":"616161",
    "integracao":{
      "xpto":"voluptatibus",
      "xyz":"quibusdam",
      "abcdef":9288701
    }
  },
  "responsavelAtendimento":{
    "chaveUnica":"3321",
    "numeroContrato":"444456789",
    "integracao":{
      "xpto":"voluptatibus",
      "xyz":"quibusdam",
      "abcdef":9288701
    }
  },
  "dadosContato:":{
    "nome":"Nome do contato",
    "celular":"289999999999",
    "email":"email@teste.com"
  },
  "idEspecialidade":"716171919",
  "idLocal":"818181",
  "idProfissional":"81818",
  "idAgenda":"123123",
  "dataHora":"2022-02-01 11:30:00"
}

Request body

{
    "identificadorExterno": "564657688",
    "chaveUnica": "13331584754",
    "tipoMeeting": 1,
    "responsavelAtendimento": {
        "nome": "Patrick Oliveira",
        "chaveUnica": "13331584754"
    },
    "paciente": {
        "chaveUnica": "13331584754",
        "numeroContrato": "999999"
    }
}


Objetos e atributos de retorno

Retorno de sucesso:

{
    "status": true,
    "data": {
        "identificadorExterno": "teste01",
        "idMeeting": "7cfcfc08-f43b-48b5-b25b-ba61752107a1"
    },
    "message": "Agenda criada com sucesso.",
    "critical": [],
    "statusCode": 200,
    "timestamp": 1684180810946
}

Retorno em caso de erro:

{
    "status": false,
    "data": {},
    "message": "O campo [identificadorExterno] já existe.",
    "critical": [
        {
            "code": "ERR_INVALID_ARGUMENT_REQUEST",
            "statusCode": 422
        }
    ],
    "statusCode": 422,
    "timestamp": 1684180848648
}