Mais Chat API (3.0.0)

Download OpenAPI specification:

Suporte Mais Chat: [email protected] URL: https://maischat.com

Documentação pública da Mais Chat API.
API REST para uso restrito a clientes da Mais Chat.

🔑 Autenticação

Todas as chamadas exigem o header authorization no formato:

authorization: Bearer {{tenantToken}}
Content-Type: application/json

O tenantToken é exclusivo do cliente e deve ser solicitado ao Suporte Mais Chat.
Sem esse header a API responderá 401 Unauthorized.

⚠️ Limite de Requisições (Rate Limit)

Todas as rotas da API possuem rate limit para garantir a estabilidade do serviço.
Para detalhes sobre limites específicos ou aumento de capacidade, entre em contato com o Suporte Mais Chat.

Mensagens

Envio e consulta de mensagens

Listar mensagens de API enviadas por canal

Retorna a lista de mensagens enviadas pela API através de um canal específico (appId) ou número de origem associado.
A rota suporta paginação e permite consultar o histórico de mensagens enviadas, incluindo metadados sobre o envio, status de entrega (ack), payload da requisição e resposta do provedor (ex: WhatsApp Cloud API).

Cada item retornado representa uma mensagem enviada pelo sistema, com dados completos sobre:

Identificadores internos e externos (IDs do WhatsApp, appId, tenant).
Status de entrega e logs de confirmação (ack, ackLog).
Conteúdo e componentes da mensagem (texto, botões, rodapé).
Informações do remetente, destinatário e tenant.
Payload da requisição original enviada ao broker e a resposta recebida.

Limite de requisições (rate limit):

Máximo de 100 requisições a cada 1 minuto.

Authorizations:

bearerAuth

path Parameters

mobile

required

string

Identificador do canal (appId) ou número do remetente configurado no broker.

query Parameters

limit	integer Default: 10
offset	integer Default: 0 Example: offset=200 Número de registros a serem ignorados antes de iniciar a listagem. Usado para paginação em conjunto com o parâmetro `limit`.

Responses

Response samples

200
400

Content type

application/json

{"status": true,
"data": [{"_id": "abc1234567890fakeid",
"type": "wppCloudAPI",
"from": "55999998888",
"to": "5541999887766",
"message": "Olá João, seu pedido #12345 foi confirmado!",
"ack": "2",
"ackLog": [{"ack": "1",
"createdAt": "2025-09-23T10:00:00.000Z"
},
{"ack": "2",
"createdAt": "2025-09-23T10:01:10.000Z"
}
],
"components": [{"type": "BODY",
"text": "Olá João, seu pedido #12345 foi confirmado!"
},
{"type": "FOOTER",
"text": "Obrigado por comprar conosco!"
},
{"type": "BUTTONS",
"buttons": [{"type": "text",
"text": "Ver detalhes",
"sub_type": "url",
"index": "0",
"url": "https://example.com/pedido/12345",
"buttonText": "Acompanhar pedido",
"link": "https://example.com/pedido/12345"
}
]
}
],
"payload": {"request": {"type": "apiTemplate",
"broker": "wppCloudAPI",
"appId": "111111111111111",
"source": "55999998888",
"destination": "5541999887766",
"template": {"name": "pedido_confirmado",
"language": "pt_BR",
"components": [{"type": "body",
"parameters": [{"type": "text",
"text": "12345"
}
]
}
]
}
},
"response": {"messaging_product": "whatsapp",
"contacts": [{"input": "5541999887766",
"wa_id": "5541999887766"
}
],
"messages": [{"id": "wamid.fakeMessageId123",
"message_status": "accepted"
}
]
}
},
"tenant": {"_id": "fakeTenantId123",
"name": "Loja Exemplo",
"id": "fakeTenantId123"
},
"createdAt": "2025-09-23T10:00:00.000Z",
"updatedAt": "2025-09-23T10:01:10.000Z"
}
]
}

Listar mensagens por número de destino

Retorna a lista de mensagens enviadas pela API através do número de destino.

Limite de requisições (rate limit):

Máximo de 100 requisições a cada 1 minuto.

Authorizations:

bearerAuth

path Parameters

destination

required

string

query Parameters

limit	integer Default: 10
offset	integer Default: 0 Example: offset=200 Número de registros a serem ignorados antes de iniciar a listagem. Usado para paginação em conjunto com o parâmetro `limit`.

Responses

Response samples

200
400

Content type

application/json

{"status": true,
"data": { }
}

Templates

Gerenciamento e envio de templates

Listar templates cadastrados

Retorna a lista de templates cadastrados na Meta.

Meta Cloud API (WhatsApp): Informe appId via query para filtrar os templates do aplicativo específico (requisito da Meta).
O retorno é um array de templates com nome, idioma, status de aprovação, categoria e componentes (ex.: BODY com placeholders {{1}}, {{2}} etc).

Limite de requisições (rate limit):

Máximo de 10 requisições a cada 1 minuto.

Authorizations:

bearerAuth

path Parameters

broker

required

string

Value: "wppCloudAPI"

query Parameters

appId

required

string

Example: appId=123456789012345

Identificador do aplicativo na Meta Cloud API. Obrigatório quando broker=meta (ou equivalente) e a integração exigir app por escopo.

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"status": true,
"data": [{"name": "saudacao",
"parameter_format": "POSITIONAL",
"components": [{"type": "BODY",
"text": "Olá {{1}}, me chamo {{2}} da Mais Chat.",
"example": {"body_text": [["João",
"Maria"
]
]
}
}
],
"language": "pt_BR",
"status": "APPROVED",
"category": "MARKETING",
"id": "1511471309205472"
}
]
}

Envia mensagem de template

Envia uma mensagem de template (mensagem pré-aprovada pela Meta/WhatsApp) pelo broker Meta Cloud API. Templates são usados para iniciar ou retomar conversas fora da janela de 24h e para comunicações padronizadas (notificações, alertas, confirmações etc.). A propriedade template deve seguir obrigatoriamente o formato e as regras da documentação oficial da Meta: https://developers.facebook.com/docs/whatsapp/cloud-api/guides/send-message-templates. Apenas templates previamente aprovados e ativos podem ser utilizados.

Limite de requisições (rate limit):

Máximo de 500 requisições a cada 1 minuto.

Authorizations:

bearerAuth

path Parameters

broker

required

string

Value: "wppCloudAPI"

Request Body schema: application/json
required

One of

type required	string Value: "apiTemplate" Tipo de operação; para Meta Cloud use sempre `apiTemplate`.
broker required	string Value: "wppCloudAPI" Broker de envio; atualmente suportado: `wppCloudAPI` (Meta Cloud API).
appId required	string Phone Number ID do seu canal (número do WhatsApp Business na Meta).
source required	string Número do remetente (seu canal) em formato E.164 (ex.: 5511999991234).
destination required	string Número do destinatário em formato E.164 (ex.: 5511912341234).
token required	string Token do Graph API (Meta Cloud) com permissões para envio.
required	object Dados do template conforme a documentação oficial da Meta: https://developers.facebook.com/docs/whatsapp/cloud-api/guides/send-message-templates. Deve referenciar um template aprovado e ativo na sua conta WhatsApp Business. Campos mínimos: - `name`: nome do template aprovado. - `language`: código no formato `<lang>_<REGION>` (ex.: `pt_BR`). - `components`: lista de componentes compatíveis (corpo, cabeçalho, mídia, botões, variáveis, ações como `flow` etc.) exatamente como definido no template aprovado.

Responses

Request samples

Payload

Content type

application/json

{"type": "apiTemplate",
"broker": "wppCloudAPI",
"appId": "317774448096214",
"source": "5511999991234",
"destination": "5511912341234",
"token": "EAA...",
"template": {"name": "flow_meta_2",
"language": "pt_BR",
"components": [{"type": "header",
"parameters": [{"type": "image",
"image": {"link": "https://example.com/uma-imagem.jpg"
}
}
]
},
{"type": "body",
"parameters": [{"type": "text",
"text": "João"
}
]
},
{"type": "button",
"sub_type": "flow",
"index": "0",
"parameters": [{"type": "action",
"action": {"flow_token": "{\"flowId\": 3293039314163350}"
}
}
]
}
]
}
}

Response samples

200
400

Content type

application/json

{"status": true,
"data": {"messaging_product": "whatsapp",
"contacts": [{"input": "5511912341234",
"wa_id": "5511912341234"
}
],
"messages": [{"id": "wamid.HBgMNTU0ODg4MTU2NTg2FQIAERgSQjQ3MzM1QUZGRDlDMkQxNTkyAA==",
"message_status": "accepted"
}
],
"msgId": "66be3b896671d540a47be362"
}
}

Brokers

Informações sobre brokers conectados (status, lista)

Listar brokers configurados

Retorna a lista de brokers configurados na plataforma, incluindo dados técnicos e de identificação necessários para integração com os canais de mensagens.

Limite de requisições (rate limit):

Máximo de 10 requisições a cada 1 minuto.

Authorizations:

bearerAuth

Responses

Response samples

200
500

Content type

application/json

{"status": true,
"data": [{"version": null,
"_id": "65eb2a5529408895f2afc3da",
"broker": "wppCloudAPI",
"name": "Exemplo - Cloud",
"app": "Exemplo Tecnologia",
"appId": "234057352740299",
"wabaId": "267173379104556",
"number": "5511912341234",
"token": "EAA..."
}
]
}

Contatos

Consulta e cadastro de contatos

Listar contatos cadastrados

Retorna uma lista de contatos cadastrados na plataforma.
A listagem pode ser paginada com limit e offset, e filtrada pelo período de criação/atualização utilizando startTime e endTime.

Observações:

O parâmetro limit possui limite máximo de 1000 registros por requisição.
Caso seja informado um valor superior a 1000, automaticamente será considerado 1000.
O retorno inclui metadados como count (quantidade retornada) e countTotal (quantidade total de registros no banco).

Limite de requisições (rate limit):

Máximo de 15 requisições a cada 5 segundos.

Authorizations:

bearerAuth

query Parameters

limit	integer <= 1000 Default: 100 Número máximo de contatos a serem retornados por requisição (máx. 1000).
offset	integer Default: 0 Example: offset=200 Número de registros a serem ignorados antes de iniciar a listagem. Usado para paginação em conjunto com o parâmetro `limit`.
startTime	string <date> Example: startTime=2023-03-01 Data inicial de cadastro do contato. Se informado, `endTime` também deve ser informado.
endTime	string <date> Example: endTime=2024-03-31 Data final de cadastro do contato. Se informado, `startTime` também deve ser informado.

Responses

Response samples

200
500

Content type

application/json

{"status": true,
"data": [{"linked": [ ],
"externalCode": null,
"countryCode": "55",
"tags": [{"_id": "5f91c4a9fccea6157cf2f",
"tag": "NOVO"
},
{"_id": "5f1e829f48cb380741e5cecd",
"tag": "LEAD"
}
],
"_id": "68d215cd92eeb37882463a09",
"name": "Pedro Augusto",
"email": "[email protected]",
"celular": "11912341234",
"notes": [{"_id": "68d215cd79eeb3278d461a01",
"type": "text",
"date": "2025-09-23T03:36:45.124Z",
"text": "<div><b>Contato cadastrado automaticamente</b></div><p>Este contato foi cadastrado automaticamente pelo canal WhatsApp Business.</p>"
}
],
"createdAt": "2025-09-23T03:36:45.138Z",
"updatedAt": "2025-09-23T03:36:45.625Z",
"address": [ ],
"id": "68d2895cd79eeb37222425a03"
}
],
"count": 100,
"countTotal": 29034
}

Criar contato

Cria um novo contato na plataforma.

Detalhes:

É necessário informar pelo menos name e type.
O campo email deve ser válido quando informado.
As tags devem conter IDs válidos de tags previamente cadastradas.

Limite de requisições (rate limit):

Máximo de 15 requisições a cada 5 segundos.

Observações adicionais:

Em caso de duplicidade de celular, o sistema retornará erro 409.
As respostas seguem o padrão StandardResponse, com o objeto criado em data.

Authorizations:

bearerAuth

Request Body schema: application/json
required

name required	string
type required	string PF/PJ (case-insensitive)
cpf	string
celular	string
telefoneFixo	string
email	string <email>
departamento	string
funcao	string
	Array of objects
tags	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"name": "Fulana 5 de Tal",
"type": "pf",
"cpf": "813.844.599-87",
"celular": "48 98888-9999",
"telefoneFixo": "+34 654232147",
"email": "[email protected]",
"departamento": "Dep Teste",
"funcao": "Função teste",
"notes": [{"type": "text",
"text": "Cadastro automático via formulário"
},
{"type": "text",
"text": "Modelo de interesse xxxx"
}
],
"tags": ["5e42ab48a61cfa56d01c508e",
"60c0cd228e0e1d4a5d68d26a"
]
}

Response samples

200
400
409

Content type

application/json

{"status": true,
"data": { }
}

Obter contato por ID

Retorna dados do contato.

Limite de requisições (rate limit):

Máximo de 15 requisições a cada 5 segundos.

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response samples

200
404

Content type

application/json

{"status": true,
"data": { }
}

Atualizar contato parcialmente

Atualiza parcial de um contato existente. Todos os campos são opcionais. Se o campo name for enviado, ele não pode ser vazio.

Limite de requisições (rate limit):

Máximo de 15 requisições a cada 5 segundos.

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json
required

name	string non-empty
type	string PF/PJ (case-insensitive)
cpf	string
celular	string
telefoneFixo	string
email	string <email>
departamento	string
funcao	string
	Array of objects
tags	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"name": "Fulana de Tal (atualizado)",
"email": "[email protected]",
"notes": [{"type": "text",
"text": "Ajuste de cadastro pelo time comercial"
}
],
"tags": ["60c0cd228e0e1d4a5d68d26a"
]
}

Response samples

200
400
404

Content type

application/json

{"status": true,
"data": { }
}

Obter contato por telefone celular

Retorna dados do contado onde a busca é pelo número de celular.

Limite de requisições (rate limit):

Máximo de 15 requisições a cada 5 segundos.

Authorizations:

bearerAuth

path Parameters

cellphone

required

string

Responses

Response samples

200
429

Content type

application/json

{"status": true,
"data": { }
}

Obter tag por ID

Retorna dados da TAG.

Limite de requisições (rate limit):

Máximo de 100 requisições a cada 1 minuto.

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"status": true,
"data": { }
}

Protocolos

Consulta de protocolos e conversas

Listar protocolos

Retorna lista de protocolos.

Limite de requisições (rate limit):

Máximo de 15 requisições a cada 5 segundos.

Authorizations:

bearerAuth

query Parameters

limit	integer Default: 10
offset	integer Default: 0 Example: offset=200 Número de registros a serem ignorados antes de iniciar a listagem. Usado para paginação em conjunto com o parâmetro `limit`.
state	string Enum: "open" "closed" Filtrar por estado do protocolo
startTime	string <date> Example: startTime=2023-03-01 Data inicial de cadastro do contato. Se informado, `endTime` também deve ser informado.
endTime	string <date> Example: endTime=2024-03-31 Data final de cadastro do contato. Se informado, `startTime` também deve ser informado.

Responses

Response samples

200

Content type

application/json

{"status": true,
"data": { }
}

Obter protocolo e mensagens

Retorna os dados de um protocolo e a lista de mensagens relacionadas. Use este endpoint para inspecionar o histórico de atendimento (bot e humano), filas, tags e motivos de encerramento.

Limite de requisições (rate limit):

Máximo de 100 requisições a cada 1 minuto.

Observações:

O campo messages é retornado em ordem cronológica crescente (mais antigo → mais recente).
Os horários estão em ISO 8601 (UTC).

Authorizations:

bearerAuth

path Parameters

protocolNumber

required

string

Example: 17585415876230366

Número do protocolo (string numérica gerada pelo sistema).

Responses

Response samples

200

Content type

application/json

{"status": true,
"data": {"_id": "6ab13713fab6bcd272025a00",
"channel": "web",
"channelNumber": null,
"chatId": null,
"protocol_number": "17585415876230366",
"attendant": {"_id": "6ab198a96054aa45422ba100",
"name": "Ana Souza"
},
"contact": {"_id": "6aa214678ff52271edc7ce01",
"name": "João Pereira",
"address": null
},
"human": true,
"receptive": true,
"tags": [{"_id": "659feb1f49c7f81ec701de01",
"tag": "SUPORTE - APP WEB"
}
],
"queue": {"_id": "60d0f2a53c9b6c57b6d37301",
"name": "SAC",
"description": "Fila de atendimento geral"
},
"state_protocol": "closed",
"countMessages": 10,
"messages": [{"id": "6ab13713fab6bc4eb0025a01",
"ack": null,
"ackLog": [ ],
"hasQuotedMsg": false,
"human": false,
"template": false,
"wppId": null,
"direction": "incoming",
"message_type": "text",
"createdAt": "2025-09-22T11:46:27.639Z",
"message": "Olá, bom dia!"
},
{"id": "6ab13713fab6bc2dd6025a02",
"ack": "2",
"ackLog": [ ],
"hasQuotedMsg": false,
"human": false,
"template": false,
"wppId": null,
"direction": "outgoing",
"message_type": "text",
"createdAt": "2025-09-22T11:46:27.703Z",
"message": "Para agilizar, descreva o assunto e aguarde um atendente, por favor."
},
{"id": "6ab13713fab6bcb968025a03",
"ack": "0",
"ackLog": [ ],
"hasQuotedMsg": false,
"human": false,
"template": false,
"wppId": null,
"direction": "outgoing",
"message_type": "note",
"createdAt": "2025-09-22T11:46:27.741Z",
"message": "Direcionado pelo bot para a fila: SAC."
},
{"id": "6ab1371d5ce68b0e5dc37004",
"ack": null,
"ackLog": [ ],
"hasQuotedMsg": false,
"human": true,
"template": false,
"wppId": null,
"direction": "incoming",
"message_type": "text",
"createdAt": "2025-09-22T11:46:37.694Z",
"message": "Preciso de ajuda para criar um novo template."
},
{"id": "6ab13787d2a9b395fe6b9f05",
"ack": "0",
"ackLog": [ ],
"hasQuotedMsg": false,
"human": true,
"template": false,
"wppId": null,
"direction": "outgoing",
"message_type": "note",
"createdAt": "2025-09-22T11:48:23.125Z",
"message": "Protocolo assumido pela agente Ana Souza."
},
{"id": "6ab137eb0fc4693df670ef06",
"ack": "1",
"ackLog": [ ],
"hasQuotedMsg": false,
"human": true,
"template": false,
"wppId": null,
"direction": "outgoing",
"message_type": "text",
"createdAt": "2025-09-22T11:50:03.755Z",
"message": "Bom dia! Vou verificar para você."
},
{"id": "6ab137ee6f0f41e2285c9507",
"ack": "1",
"ackLog": [ ],
"hasQuotedMsg": false,
"human": true,
"template": false,
"wppId": null,
"direction": "outgoing",
"message_type": "text",
"createdAt": "2025-09-22T11:50:06.899Z",
"message": "Um instante, por gentileza."
},
{"id": "6ab1388bf9d6cc5a4a4acf08",
"ack": null,
"ackLog": [ ],
"hasQuotedMsg": false,
"human": true,
"template": false,
"wppId": null,
"direction": "incoming",
"message_type": "text",
"createdAt": "2025-09-22T11:52:43.130Z",
"message": "Enviei os detalhes por e-mail."
},
{"id": "6ab13b7c17e7d5411fd5b009",
"ack": "1",
"ackLog": [ ],
"hasQuotedMsg": false,
"human": true,
"template": false,
"wppId": null,
"direction": "outgoing",
"message_type": "text",
"createdAt": "2025-09-22T12:05:16.628Z",
"message": "Template criado e ativo. Qualquer ajuste, me avise."
},
{"id": "6ab18ac38291321c7490400a",
"ack": "0",
"ackLog": [ ],
"hasQuotedMsg": false,
"human": true,
"template": false,
"wppId": null,
"direction": "outgoing",
"message_type": "note",
"createdAt": "2025-09-22T17:43:31.311Z",
"message": "Protocolo encerrado pela agente Ana Souza."
}
],
"reason": {"protocolReason": {"reasonParent": null,
"reasonNote": "",
"_id": "6ab18ac3be4c840257583caa",
"reasonName": "Resolvido"
},
"reason": "660d2ef2eca7d763c325abdb",
"motive": null
},
"createdAt": "2025-09-22T11:46:27.628Z",
"humanDate": "2025-09-22T11:46:27.698Z",
"queueDate": "2025-09-22T11:46:27.698Z",
"attendanceDate": "2025-09-22T11:48:19.962Z",
"closeDate": "2025-09-22T17:43:31.270Z"
}
}

Listar protocolos abertos por número alvo

Retorna protocolos abertos onde o número alvo é o número de WhatsApp usado na conversa.

Limite de requisições (rate limit):

Máximo de 100 requisições a cada 1 minuto.

Authorizations:

bearerAuth

path Parameters

phoneNumber

required

string

Responses

Response samples

200

Content type

application/json

{"status": true,
"data": { }
}

Usuários

Listagem de usuários

Listar usuários

Retorna lista de usuários cadastrados.

Limite de requisições (rate limit):

Máximo de 20 requisições a cada 1 minuto.

Authorizations:

bearerAuth

query Parameters

limit	integer <= 1000 Default: 10 Máximo 1000 (default 10). Ordenação por nome asc.
offset	integer Default: 0 Registros a pular
ativo	boolean Filtrar por status (true/false)

Responses

Response samples

200

Content type

application/json

{"status": true,
"data": { }
}

Uso

Métricas de uso da API

Métricas de uso

Esta rota retorna métricas de uso da API em nível de tenant, rota ou identidade. É possível filtrar por período (dia/mês), intervalo de datas, rotas, status HTTP, método de requisição e tipo de identidade.

Limite de requisições (rate limit):

Máximo de 10 requisições a cada 1 minuto.

Authorizations:

bearerAuth

query Parameters

period required	string Enum: "day" "month" Example: period=month
start required	string <date> Example: start=2025-09-01 Data inicial (AAAA-MM-DD)
end required	string <date> Example: end=2025-09-30 Data final (AAAA-MM-DD)
routeContains	string Example: routeContains=/msg/template
statusClass	string Enum: "2xx" "4xx" "5xx" Example: statusClass=2xx
identityType	string Example: identityType=tenant
identityValue	string Example: identityValue=5deab0f9b7a6ac4236b5a179
method	string Enum: "GET" "POST" "PATCH" Example: method=POST
sort	string Example: sort=countTotal:-1
page	integer Default: 1 Example: page=1
limit	integer Default: 20 Example: limit=20

Responses

Response samples

200
500

Content type

application/json

{"meta": {"page": 1,
"limit": 20,
"totalItems": 7,
"totalPages": 1,
"hasNext": false,
"hasPrev": false,
"sort": {"countTotal": -1
}
},
"filters": {"period": "month",
"startKey": "202509",
"endKey": "202509",
"tenant": "",
"identityType": null,
"identityValue": null,
"routeId": null,
"routeContains": null,
"method": null,
"statusClass": null,
"minCount": 0
},
"totals": {"countTotal": 1988,
"count2xx": 1887,
"count4xx": 98,
"count5xx": 1,
"countRateLimited": 0,
"sumDurMs": 2075522,
"avgDurMs": 1044
},
"data": [{"_id": "68b56dede86f53954c04eb43",
"identityType": "tenant",
"identityValue": "5deab0f9b7a6ac4236b5a179",
"key": "202509",
"method": "POST",
"period": "month",
"routeId": "POST:/v2/msg/template/:broker",
"tenant": "5deab0f9b7a6ac4236b5a179",
"count2xx": 1690,
"count4xx": 0,
"count5xx": 0,
"countRateLimited": 0,
"countTotal": 1690,
"avgDurMs": 873,
"sumDurMs": 1475115,
"createdAt": "2025-09-01T09:57:01.076Z",
"updatedAt": "2025-09-23T11:33:17.046Z"
}
]
}

Mais Chat API (3.0.0)

🔑 Autenticação

⚠️ Limite de Requisições (Rate Limit)

Mensagens

Listar mensagens de API enviadas por canal

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Listar mensagens por número de destino

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Templates

Listar templates cadastrados

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Envia mensagem de template

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Brokers

Listar brokers configurados

Authorizations:

Responses

Response samples

Contatos

Listar contatos cadastrados

Authorizations:

query Parameters

Responses

Response samples

Criar contato

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Obter contato por ID

Authorizations:

path Parameters

Responses

Response samples

Atualizar contato parcialmente

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Obter contato por telefone celular

Authorizations:

path Parameters

Responses

Response samples

Tags

Obter tag por ID

Authorizations:

path Parameters

Responses

Response samples

Listar todas as tags

Authorizations:

Responses

Response samples

Protocolos

Listar protocolos

Authorizations:

query Parameters

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required