SendKuy

Read the SendKuy account behind this API key: plan, remaining credits per channel (WhatsApp, SMS, email), messages used this billing period, the rate limit, and the scopes this key holds. Check credits before a large send. plan, credits and usage are null for SendKuy staff keys.

无需输入参数。

Send one message body to 1 to 100 recipients on one channel: WhatsApp, SMS or email. Use it for an alert, a summary or a one-off notification where everyone gets the same text. To reach a saved contact group, put its grp_ id in to. When each recipient needs different content (a summary per branch, a notification per order) use sendkuy_send_batch. A campaign prepared in the SendKuy dashboard is started with sendkuy_start_campaign and can be paused or cancelled midway. Phone numbers must be E.164 with the leading + (for example +6281234567890). This really sends and spends SendKuy credit. A recipient on the suppression list or who unsubscribed still gets a message id and fails later; read the final status with sendkuy_get_messages. One recipient is sent while you wait; several are queued and sent in the background, paced per number. Pass dedupe_key so a retried step does not send twice. The answer counts every message per status and lists the first 20; read the rest with sendkuy_list_messages.

Send up to 500 independent messages in one call, each with its own channel, recipient and body. Use it when the content differs per recipient: a revenue summary per branch, a notification per order, a reminder per invoice. Every row is answered on its own: one bad number or a channel out of credit fails that row only, and the rest still go out. The answer lists the message id of every row in input order (null where the row failed) and each failed row with its error. Messages are queued and sent in the background, paced per number. This really sends and spends SendKuy credit. A recipient on the suppression list or who unsubscribed still gets a message id and fails later; read the final status with sendkuy_get_messages. Pass dedupe_key so a retried step does not send the batch twice.

Read the current status of 1 to 20 messages by id (msg_...): queued, scheduled, sending, sent, delivered, read, failed, cancelled and so on, with the error when one failed. Use it after a send to confirm delivery, or to find out why a message failed.

List recent messages, newest first, filtered by channel, status and creation time. Use it to answer "which WhatsApp messages failed in the last hour?" while debugging an integration. To check specific messages, use sendkuy_get_messages.

Cancel a message that has not been sent yet, such as a scheduled one or one still queued in a batch. A message already handed to the provider cannot be called back.

Send a one-time code to a phone number or email address and get a verification id (vrf_...). SendKuy generates the code, sends it, and falls back through the channels you list in order. Check what the user typed with sendkuy_check_verification. This really sends and spends SendKuy credit. Pass dedupe_key so a retried step does not send a second code.

Check the code a user typed against a verification from sendkuy_send_verification. status approved means the code was right. A wrong code answers verification_code_invalid and uses up one of checks_remaining.

Check whether up to 50 phone numbers are registered on WhatsApp before you send to them. Numbers must be E.164 with the leading +; a local number without the country code comes back registered: null. Limited to 10 calls a minute per key.

Find one saved contact by phone number (E.164) or by external_id, the id your own system gave the customer. Returns contact: null when nobody matches. Use the contact id (con_...) as a recipient in sendkuy_send_message.

List the message templates saved in SendKuy, with their channel, subject and body. Variables in a body are written as placeholders the template fills in. Pass a WhatsApp template id as template_id to sendkuy_send_message.

List the contact groups in SendKuy with how many contacts each holds. Put a group id (grp_...) in the to field of sendkuy_send_message to send to every member; check contact_count first, because every member is charged.

List campaigns, newest first, with their status and audience size (total_contacts). Campaign content is written in the SendKuy dashboard; a draft found here is ready to run with sendkuy_start_campaign.

Start a draft or scheduled campaign. An instant campaign starts sending to every eligible contact in its group, is refused with insufficient_credits when the balance does not cover them, and spends real SendKuy credit. A scheduled or recurring campaign waits for its time. If a person is in the conversation, tell them the campaign name and total_contacts before you start it. Pause or cancel it with sendkuy_control_campaign.

Read a campaign: status, progress (processed_contacts of total_contacts), why it is paused, and delivery stats (sent, delivered, failed, opened, replied, unsubscribed) overall and per channel.

Pause a running campaign, resume a paused one, or cancel it for good. Pause is the emergency brake when a campaign is going out wrong: messages not yet sent stay unsent until you resume. Cancel cannot be undone.

Show the webhooks on this account and their latest delivery attempts: the HTTP status your endpoint answered, the error, an excerpt of the response, and when the next retry is due. Use it to answer "why is my webhook failing?". Without webhook_id it reads the first five webhooks.