SDKs

Three libraries, maintained by SendKuy, cover every endpoint in this reference. Field names are the API's own, so each request in the reference maps one to one onto an SDK call.

Send your first messageCopy Anchor Link

import { SendKuy } from 'sendkuy';

const sendkuy = new SendKuy('sk_live_YOUR_API_KEY');

const [message] = await sendkuy.messages.send({
  channel: 'whatsapp',
  to: ['+6281234567890'],
  body: 'Your order is on its way.',
});

What the SDKs handle for youCopy Anchor Link

• Retries without duplicates. Every write carries an Idempotency-Key, and each retry of that call reuses it, so a retry after a timeout or a dropped connection gets the first answer instead of sending again. The SDKs retry network errors, timeouts, 5xx, idempotency_request_in_progress, and 429 when Retry-After is a minute or less, up to twice. See Idempotency.
• Pagination. autoPaginate() follows next_cursor until the last page. See Pagination.
• Typed errors, one class per error.type, carrying code, param, the documentation link and the request id.
• Webhook signatures, checked in one call. See Webhooks.
• Types. The Node.js SDK ships TypeScript types generated from this API's contract; the PHP SDK gives your editor every field of every object.

ErrorsCopy Anchor Link

Every class extends SendKuyError in Node.js and SendKuyException in PHP, so one catch covers them all. Branch on the code, never on the message: error.code in Node.js, $e->getErrorCode() in PHP. The full list is on Errors.

Each error also carries the HTTP status (error.status, $e->getHttpStatus()) and, on a 429, the seconds to wait (error.retryAfter, $e->getRetryAfter()). A webhook that fails verification raises SignatureVerificationError or SignatureVerificationException, whose reason is one of malformed_header, timestamp_out_of_tolerance, signature_mismatch or invalid_payload.

Configure the clientCopy Anchor Link

The API key is the first argument. In Node.js you may leave it out, and SENDKUY_API_KEY is read from the environment. The other options go in the second argument:

const sendkuy = new SendKuy('sk_live_YOUR_API_KEY', { timeout: 10_000, maxRetries: 1 });

With your own http_client in PHP, set the timeout on that client: the SDK's timeout does not reach it. The Node.js SDK refuses to run in a browser, where anyone who opens the page could read your key; dangerouslyAllowBrowser: true overrides that. In Laravel, every option is an environment variable; see Configuration.

One call can override the timeout and carry its own idempotency key. Node.js also takes an AbortSignal:

await sendkuy.messages.send(params, { timeout: 5_000, idempotencyKey: 'order-1042-shipped' });

VersionsCopy Anchor Link

Version 1.x of each SDK covers API v1. Every release is listed in the CHANGELOG for Node.js, PHP and Laravel.

MethodsCopy Anchor Link

Every endpoint in this reference has a method. An endpoint newer than your installed version is still one call away with request(): sendkuy.request({ method: 'GET', path: '/account' }) in Node.js, $sendkuy->request('GET', '/account') in PHP.