POST/api/v2/messages

Send a message

One endpoint for WhatsApp (scan QR) and WhatsApp Official: text, a file, a template, or an OTP code.

Choose the channel with channel. Klik Flow uses the first number the key may use, or the number in from. Outside 24 hours since the customer last wrote, WhatsApp Official can only send template or otp. Send an Idempotency-Key header so a retry does not produce a second message. Test keys send only to test numbers.

Send an Idempotency-Key header (for example a new UUID per request). A repeat with the same key within 24 hours gets the first answer again, so nothing is sent twice.

OTP code: {"channel":"whatsapp_official","to":"62812…","type":"otp","otp":{"template":"kode_login","code":"482913"}}.

Key: kf_live_ / kf_test_… in the Authorization: Bearer header. Created in Settings › API & Webhook › Create key (Pengaturan › API & Webhook › Buat kunci).
Key scope: messages:send
Plan feature: WhatsApp sending API

Body (JSON)

channelstring: whatsapp_qr | whatsapp_officialrequired
Sending channel.
tostringrequired
Destination number with country code; 08… is changed to 628….
typestring: text | image | video | audio | document | template | otprequired
Message type. template and otp are for whatsapp_official only.
fromstring
A specific sender number: the device id (whatsapp_qr) or number id (whatsapp_official), from GET /api/v2/channels.
textobject
{ "body": "…" }, at most 4,000 characters. For type text.
mediaobject
url (https) or base64 + mime, with filename and caption. For file types.
templateobject
name, language, variables (object or array), header_variables, media_url, button_url, coupon_code.
otpobject
template (an Authentication template) and code (1–15 letters, digits, or -). The code is not stored.

Possible errors

400 invalid_json Body is not valid JSON
400 idempotency_key_invalid Invalid Idempotency-Key
401 missing_key API key not sent
401 key_invalid Unknown API key
401 key_revoked API key revoked
401 key_expired API key expired
401 member_inactive Key creator is no longer a member
403 ip_not_allowed Server IP not in the key's list
403 plan_no_api Plan does not include the API for live keys
403 tenant_blocked Business access suspended
403 scope_missing Key lacks this permission
403 permission_missing Key creator's role lacks this permission
403 test_number_required Test keys send only to test numbers
403 channel_not_allowed Channel not allowed for this key
403 channel_paused Channel paused
404 not_found Not found
404 template_not_found Template not found or not approved
409 idempotency_conflict Idempotency-Key used for different content
409 request_in_progress The same request is still being processed
409 channel_unavailable No usable WhatsApp number
409 window_closed Outside the 24-hour window
413 media_too_large File too large
422 invalid_request Invalid field
422 invalid_phone Invalid destination number
422 message_too_long Message too long
422 contact_blocked Contact blocked or unsubscribed
422 template_values Template variables incomplete
422 template_not_supported Template type not supported yet
422 otp_code_invalid Invalid OTP code
429 rate_limited Too many requests per minute
429 daily_limit Daily message limit reached
429 new_chat_limit Limit of chats to new numbers reached
500 internal_error Problem at Klik Flow
502 send_failed Message failed to send
502 channel_refused WhatsApp refused the message

Try it

Try it with a test key

Test API keyTest keys only (kf_test_…), kept in this tab only and sent only to this site's API. Body (JSON)Idempotency-Key

/api/v2/messages

Request example

curl -X POST "https://klikflow.id/api/v2/messages" \
  -H "Authorization: Bearer KUNCI_API" \
  -H "Idempotency-Key: 6f1c2a8e-4b1d-4c3a-9e2f-1a2b3c4d5e6f" \
  -H "Content-Type: application/json" \
  -d '{"channel":"whatsapp_official","to":"6281234567890","type":"template","template":{"name":"konfirmasi_pesanan","language":"id","variables":{"nama":"Rina","orderid":"INV-2207"},"button_url":"INV-2207"}}'

Response example 200

{
  "data": {
    "id": 99140,
    "object": "message",
    "conversation_id": 812,
    "channel": "whatsapp_official",
    "to": "6281234567890",
    "type": "template",
    "status": "sent",
    "test": false
  }
}

Body (JSON)

Possible errors

Try it

Send WhatsApp from your system with the Klik Flow API.