reachflow 0.3.0

Official Python client for the ReachFlow public REST API (WhatsApp, OTP)

reachflow

Official Python client for the ReachFlow public API (REST v1).

Installation

pip install reachflow

Requirements: Python ≥ 3.10.

Configuration

from reachflow import ReachFlow

client = ReachFlow(
    api_key="rfl_live_…",  # or rfl_test_…
    environment="sandbox",  # or "live" — default: "sandbox"
    timeout_ms=30_000,
    max_retries=2,
)

environment	API host
sandbox (default)	sandbox-api.reachflow.me
live	api.reachflow.me

Use a context manager to close the HTTP connection:

with ReachFlow(api_key="rfl_live_…") as client:
    ...

Examples

Send a message

with ReachFlow(api_key="rfl_live_…") as client:
    result = client.messages.send(
        provider_id="your-provider-uuid",
        to="22996123456",
        message="Your order is confirmed.",
    )
    status = client.messages.wait_for_terminal(result["messageId"])
    print(status["status"])

OTP

with ReachFlow(api_key="rfl_live_…") as client:
    sent = client.otp.send(
        provider_id="your-provider-uuid",
        phone_number="22996123456",
        brand_name="My App",
    )
    # Code is delivered on WhatsApp only — never in the JSON response.
    verified = client.otp.verify(otp_id=sent["otpId"], code="482910")
    print(verified["valid"])

Async client

from reachflow import AsyncReachFlow

async with AsyncReachFlow(api_key="rfl_live_…") as client:
    providers = await client.providers.list()

Error handling

from reachflow import ReachFlow, ReachFlowError

try:
    client.messages.send(...)
except ReachFlowError as err:
    print(err.status_code, err.code, err.message)
    if err.retryable:
        ...

Idempotency

client.messages.send(
    provider_id=provider_id,
    to=to,
    message=message,
    idempotency_key="order-12345",
)

Development

pip install -e ".[dev]"
pytest

License

MIT