DKBSignDocs

API reference

POSTRequires Bearer token

Send SMS or WhatsApp

/api/notifications/sms

Queue an SMS or WhatsApp message. Delivery is asynchronous (202).

  • channel is sms or whatsapp. WhatsApp uses the same body; the company must have the WhatsApp module enabled.
  • phone_number must be E.164 and start with +.
  • message is limited to 255 characters.
  • The company SMS or WhatsApp quota is consumed before the job is queued. When the quota is exhausted the response is 429 with error_code SMS_QUOTA_REACHED or WHATSAPP_QUOTA_REACHED.
  • A user token is gated by the company notification modules. A license in read-only grace returns 403 LICENSE_READONLY.

Path parameters

This endpoint has no path parameters.

Query parameters

This endpoint has no query parameters.

Request body

FieldTypeDescription
channel
Required
stringsms or whatsapp.
e.g. "sms"
phone_number
Required
stringRecipient in E.164 format (must start with +).
e.g. "+2250700000001"
message
Required
stringMessage body (max 255 characters).
e.g. "Your code is 00990"

Responses

StatusMeaning
202Queued for delivery
429Quota exhausted
401Missing or invalid Bearer token.

Request

curl
curl -X POST 'https://api.dkbsigns.com/api/notifications/sms' \
  -H 'Authorization: Bearer $DKBSIGN_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"channel":"sms","phone_number":"+2250700000001","message":"Your code is 00990"}'

Response 202

json
{
  "status": "success",
  "message": "Notification sent successfuly"
}