API Reference converger_client v#0.1.0

Copy Markdown View Source

Modules

Elixir client for Converger.

The server ack of a socket send with a clientId.

The canonical activity (tenant API, delivery payloads and outbound webhook bodies, which add timestamp). Timestamps are ISO 8601 strings.

The sender of a client API activity.

The client API under /api/v1/converger, authenticated with converger tokens (Authorization: Bearer). Your backend mints tokens with the channel secret (generate_token/2) and hands conversation-bound tokens to end users, or uses them itself (for example with ConvergerClient.Socket).

An activity as the client API renders it (camelCase on the wire). Timestamps are ISO 8601 strings.

A conversation as the tenant API renders it. Timestamps are ISO 8601 strings.

Returned by the client API close and reopen calls.

A non-2xx HTTP response, normalized whatever error shape the server used: the standard envelope {"error": {"code", "message", "details", "request_id"}} (#45) or one of the legacy shapes (packages/conformance/errors.json).

Defines response structs from a field list.

The external party of a conversation (for example a WhatsApp number).

Transport-independent Protocol v1 resume state machine.

Protocol v1 WebSocket client for the native endpoint (/socket/converger/v1), built on Mint.WebSocket.

The tenant API under /api/v1, authenticated with the tenant API key (x-api-key). For bots, CRMs and other backends.

Verification of Converger outbound webhook signatures.