Skip to content
Get an API key

Get started

Get started

From nothing to a first message sent and answered, in three calls.

Before the first call

  • Create an account, a workspace, and connect a WhatsApp number in the console. The number belongs to your client; Nodium does not provide numbers.
  • When you connect the number, choose who answers: the Nodium collaborator, or your software. With "my software answers", no AI speaks on that number: messages arrive, you receive them by webhook, and you reply through the API.
  • Create an API key in the console, under Developers. Keys are only ever created in a signed-in session — never through the API — so a leaked key cannot mint others.
  • Register a webhook address (console, or POST /webhooks) so Nodium can tell you when a customer writes.

Three calls

Shell

# 1. Which numbers can I send from?curl https://nodium.io/api/v1/inbox/channels \ -H "Authorization: Bearer $NODIUM_KEY"# 2. Write first to a customer: on WhatsApp, an approved templatecurl https://nodium.io/api/v1/inbox/conversations \ -H "Authorization: Bearer $NODIUM_KEY" \ -H "Content-Type: application/json" \ -d '{ "channelId": "<channel id>", "to": "+33612345678", "templateId": "<approved template id>", "variables": { "1": "Karim" }, "idempotencyKey": "order-1042-confirmation" }'# 3. The customer answers: you receive message.received on your webhook.# Reply in free text, within 24 hours:curl https://nodium.io/api/v1/inbox/conversations/<conversation id>/messages \ -H "Authorization: Bearer $NODIUM_KEY" \ -H "Content-Type: application/json" \ -d '{ "text": "Yes, it is ready.", "idempotencyKey": "order-1042-reply-1" }'

That is the whole loop: list your channels, write first with an approved template, receive the answer by webhook, reply in free text. To hand the conversation to the AI collaborator — on a channel that has one — POST /inbox/conversations/{id}/ai with { "enabled": true }.

Where to look next

  • Authentication — what a key can and cannot do.
  • Responses and errors — the data / error envelope, pagination, limits.
  • The 24-hour window — the WhatsApp rule that decides what you may send.
  • Sending — idempotency keys and sending in bulk.
  • Webhooks — events, signatures, retries.