Python 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

Add the SDK to your project from its folder, with whichever package manager your project uses. Give each tool a path containing a slash, such as ../cequens-apis — a bare folder name is looked up on PyPI instead, and resolves to whatever project holds that name there:

pip install <path-to-sdk>

uv add <path-to-sdk>

poetry add <path-to-sdk>

Quick StartCopy Anchor Link

Synchronous clientCopy Anchor Link

Construct CequensApisClient with keyword arguments, and call close() when you are done. Every argument is optional.

from cequens_apis import CequensApisClient

client = CequensApisClient(bearer_auth="YOUR_BEARER_TOKEN", environment="production")

client.close()

Alternatively, scope it — with CequensApisClient(...) as client: closes the pool on exit.

Asynchronous clientCopy Anchor Link

AsyncCequensApisClient mirrors CequensApisClient with identical method names, and every endpoint method is a coroutine. It takes the same arguments, with some differences — for example, the transport argument is custom_async_http_client.

from asyncio import run

from cequens_apis import AsyncCequensApisClient


async def main() -> None:
    client = AsyncCequensApisClient(bearer_auth="YOUR_BEARER_TOKEN", environment="production")
    await client.aclose()


run(main())

Alternatively, scope it — async with AsyncCequensApisClient(...) as client: closes the pool on exit.