KapsoEx.Platform (kapso_ex v0.1.0)

Copy Markdown View Source

The Platform API (https://api.kapso.ai/platform/v1): everything around the messages, such as onboarding customers, connecting numbers, setup links, broadcasts, webhooks and project data.

Conventions

  • Functions take attributes as maps or keyword lists. When an endpoint expects the attributes under a root key (for example {"customer": {...}}), the function adds it for you:

    KapsoEx.Platform.Customers.create(client, %{name: "Acme", external_customer_id: "acme-1"})
# POST /customers  {"customer": {"name": "Acme", "external_customer_id": "acme-1"}}

  • Responses keep Kapso's envelope: %{"data" => ...}, plus "meta" (page based lists) or "paging" (cursor based lists). Use KapsoEx.Pagination.stream/2 to walk all pages.

Modules: