Skip to main content

POST Notificar Teste Rápido

Envia notificação do teste rápido via WhatsApp. Emite evento para enviar a mensagem ao WhatsApp do paciente.

Autenticação necessária

Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.

Sem permissão específica

Não exige @CheckPermissions — basta estar autenticado.


Endpoint​

POST https://api-dev.imagemais.com.br/api/rapid-tests/notify

Corpo da Requisição​

CampoTipoObrigatórioValores válidosDescrição
phoneNumberstring✅não vazioTelefone do paciente (WhatsApp)
messagestring✅não vazioTexto da mensagem enviada ao paciente
patientNamestring❌—Nome do paciente

Requisição​

curl -X 'POST' \
'https://api-dev.imagemais.com.br/api/rapid-tests/notify' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}' \
-H 'Content-Type: application/json' \
-d '{
"phoneNumber": "81999999999",
"message": "Olá João, seus sinais vitais estão...",
"patientName": "João Silva"
}'

Respostas​

201 Sucesso​

400 Requisição inválida​

Retornado quando o corpo ou a query não passam na validação. A lista message traz um item por regra violada, por exemplo:

{
"message": [
"phoneNumber should not be empty",
"phoneNumber must be a string",
"message should not be empty",
"message must be a string"
],
"error": "Bad Request",
"statusCode": 400
}