Skip to main content
These endpoints require an admin-scoped API key or an authenticated Inkbox Console session. Paths are relative to https://inkbox.ai/api/v1/whatsapp. They manage resources your organization already owns; they do not purchase or provision numbers, shared pools, or routers. Contact support@inkbox.ai to request those resources. The SDK and CLI methods below require version 0.7.38 or later and an API supporting these management endpoints.

List dedicated numbers

Returns { "numbers": [...], "has_more": false }. Each page contains up to 100 numbers; add 100 to offset while has_more is true. Each number has:

Assign or detach a number

Pass an agent in your organization to attach the number. Pass agent_identity_id: null to detach it. The response is the updated number object. Refresh the number before retrying a 409 conflict; the request must use its current revision. If the number differs from the agent’s iMessage number, explicitly confirm that difference before submitting confirmed_imessage_number with the current iMessage number. Do not populate confirmation automatically. Detaching a number can require setup assistance before it can be attached again. A successful assignment does not permit unsolicited messages.

Read and edit your dedicated router

The read returns { "router": null } when your organization has no enabled dedicated router. Otherwise, router contains id, number, revision, state, nullable profile_display_name, and accepting_new_connections. This endpoint does not allocate a global router; use Get router number for recipient connection instructions. To edit, submit the ID and revision you read:
Both values identify the router configuration you intend to change. A replacement router or stale revision returns 409; refresh and review the new router before retrying. Omit profile_display_name to preserve it, or pass null to clear it. Omit accepting_new_connections to preserve admission. Disabling new connections does not disconnect existing recipients. The response uses the same router envelope as the read.

Read dedicated-router conversations

Use an E.164 remote_number. Both endpoints return { "items": [...], "has_more": false }, newest first. limit is 1–100, defaults to 50, and offset defaults to zero. Increase offset by limit to continue. Thread items contain remote_number, last_message_at, latest_text, and message_count. Message items contain id, direction (inbound or outbound), content, status, and created_at. Router messages are separate from your agent’s conversations. Methods are on inkbox.whatsapp in Python/TypeScript and inkbox.whatsapp() in Rust. CLI examples use the inkbox executable. Pass null/None instead of the agent ID to detach; use --detach in the CLI.

Errors