Send appointment confirmation or reminder

Sends a notification to the patient via WhatsApp using a Meta-approved template, referenced by templateId.

• Use it to send the appointment confirmation right after scheduling.
• Also use it to send the reminder before the appointment day.
• Templates and their variables are configured in the Omniloy panel.

POST /whatsapp/messages/template

cURL

confirmacion

curl --request POST \
  --url https://{your-prod-endpoint}/whatsapp/messages/template \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "phoneNumber": "[phone]",
  "templateId": "2f3f8e64-2a1d-4b73-b7e4-9f0a7d6f8e10",
  "params": [
    "Dr. García",
    "martes 15 de julio",
    "11:00",
    "Cardiología - Centro Norte"
  ]
}
'

202

{
  "messageId": "<string>"
}

Authorizations

X-Api-Key · string · header · required

API Key provided by Omniloy. The same key is used for inbound and outbound calls.

Body

application/json

WhatsApp template notification referenced by UUID.

phoneNumber · string · required

Recipient's E.164 number.

templateId · string<uuid> · required

UUID of the template approved by Meta.

params · string[]

Values (in order) for the template variables.

mediaUrl · string<uri>

Optional media URL.

Response

202

application/json

Notification accepted for sending

Response when sending a notification.

messageId · string

Internal ID.

status · enum<string>

Initial status.

Available options: queued, sent