API de clientes - Cancelamento de meeting

Regras de negócio

Efetuar o cancelamento de uma meeting.

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/cancelar	POST	application/json	Cancelar uma meeting

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

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

Parâmetro	Obrigatório	Tipo	Descrição
idMeeting*	OP	String	ID da meting
identificadorExterno*	OP	String	ID de integração externa da meeting
tipoCancelamento	M	Int	Tipo de cancelamento

Observações:

O campo idMeeting é obrigatório quando o identificadorExterno não for preenchido.
O campo identificadorExterno é obrigatório quando o idMeeting não for preenchido.

Tipos de cancelamento (enum MeetingStatus):

Enum	ID	Descrição

Enum	ID	Descrição
canceladoOperadora	3	Cancelado pela operadora
canceladoBeneficiario	4	Cancelado pelo beneficiário

Request body

{
    "identificadorExterno": "13245678910",
    "idMeeting": null,
    "tipoCancelamento": "4"
}

Objetos e atributos de retorno

Retorno de sucesso:

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

Retorno em caso de erro:

{
    "status": false,
    "data": {},
    "message": "O campo [tipoCancelamento] não possui um valor válido.",
    "critical": [
        {
            "code": "ERR_INVALID_ARGUMENT_REQUEST",
            "statusCode": 422
        }
    ],
    "statusCode": 422,
    "timestamp": 1713376356200
}