reachflow 0.1.0

Client officiel Python pour l'API publique ReachFlow

reachflow

Client officiel Python pour l’API publique ReachFlow (REST v1).

Installation

pip install reachflow

Prérequis : Python ≥ 3.10.

Configuration

from reachflow import ReachFlow

client = ReachFlow(
    api_key="rfl_live_…",  # ou rfl_test_…
    base_url="https://sandbox-api.reachflow.me",  # optionnel
    timeout_ms=30_000,  # optionnel
    max_retries=2,  # optionnel — 429 / 5xx
)

Utilisez le client comme context manager pour fermer la connexion HTTP :

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

Exemples

Envoyer un message

with ReachFlow(api_key="rfl_live_…") as client:
    result = client.messages.send(
        provider_id="uuid-du-provider",
        to="22996123456",
        message="Votre commande est confirmée.",
    )
    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="uuid-du-provider",
        phone_number="22996123456",
        brand_name="Mon App",
    )
    # Le code arrive sur WhatsApp — jamais dans la réponse JSON.
    verified = client.otp.verify(otp_id=sent["otpId"], code="482910")
    print(verified["valid"])

Client asynchrone

from reachflow import AsyncReachFlow

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

Gestion des erreurs

from reachflow import ReachFlow, ReachFlowError

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

Idempotence

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

Développement

pip install -e ".[dev]"
pytest

Licence

MIT