TypeScript SDK

IntroCopy Anchor Link

The CEQUENS APIs SDK provides access to the CEQUENS APIs REST APIs.

The CEQUENS CPaaS APIs: SMS, WhatsApp and other conversation channels, Voice, MFA/OTP verification, Number Discovery, the AI Hub knowledge base and Omni-Link notifications. Authenticate with a JWT from POST /auth/v1/tokens/ sent as Authorization: Bearer <token>.

InstallationCopy Anchor Link

The SDK compiles to dist/ before it can be referenced — run its build script once in the SDK folder, then add it to your project by path:

npm install <path-to-sdk>

Quick StartCopy Anchor Link

Create one client and reuse it. Configure its behaviour through ClientOptions.

import { CequensApIsClient, ServerEnvironment } from "cequens-apis";

const client = new CequensApIsClient({
  serverEnvironment: ServerEnvironment.Production,
  bearerAuth: "YOUR_BEARER_TOKEN",
});

Nothing in ClientOptions is required — new CequensApIsClient() compiles — and each option left out falls back to its default. serverEnvironment is spelled out above so the environment a call reaches is visible where the client is built rather than inherited silently.

From CommonJSCopy Anchor Link

The package ships both dialects from a single entry, so require works with full types. In a TypeScript CommonJS file use the import ... = require(...) form — a plain destructuring require runs fine but gives you any.

import sdk = require("cequens-apis");

const client = new sdk.CequensApIsClient({
  serverEnvironment: sdk.ServerEnvironment.Production,
  bearerAuth: "YOUR_BEARER_TOKEN",
});