API Clientes - Cancelamento da consulta

Regras de negócio

Endpoint para cancelar consulta do tipo pronto atendimento.

End-Point

Endpoint	Método	Header Content-Type	Descrição

Endpoint	Método	Header Content-Type	Descrição
https://api.mosiaomnichannel.com.br/clientes/meetings/pronto-atendimento/cancelar	POST	application/json	Cancelamento da consulta

Headers

Parâmetro	Obrigatório	Tipo	Descrição

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

Parâmetros de Body

Parâmetro	Obrigatório	Tipo	Descrição

Parâmetro	Obrigatório	Tipo	Descrição
idSenha	M	String	Id de banco de dados da consulta no seu sistema interno
responsavelAtendimento	OP	Object	Dados do responsável atendimento (Atendente que fará o atendimento)

Objeto responsavelAtendimento

Parâmetro	Obrigatório	Tipo	Descrição

Parâmetro	Obrigatório	Tipo	Descrição
codigo	OP	String	Código do atendente
nome	OP	String	Nome do atendente
descricao	OP	String	Descrição do atendente

Objetos e atributos de retorno

Descrição dos objetos e atributos de retorno - Sucesso

Está indicado abaixo a estrutura de retorno do método de envio de push.

{
    "status": true,
    "data": {},
    "message": "Consulta cancelada com sucesso.",
    "critical": [],
    "statusCode": 200,
    "timestamp": 1672064771591
}