AgentSkillsCN

kapso-api

Kapso 平台 API 适用于客户入驻、设置链接、电话号码配置以及连接状态检测。在开展多租户 WhatsApp 集成、嵌入式注册流程,或进行客户管理时,可灵活运用此 API。

SKILL.md
--- frontmatter
name: kapso-api
description: Kapso Platform API for customer onboarding, setup links, phone number provisioning, and connection detection. Use when working with multi-tenant WhatsApp integrations, embedded signup, or customer management.

Kapso Platform API

When to use

Use this skill for Platform API operations: creating customers, generating setup links, provisioning phone numbers, or detecting WhatsApp connections.

Setup

Base host: https://api.kapso.ai (scripts append /platform/v1)

Auth header:

code
X-API-Key: <api_key>

How to

Onboard a customer

  1. Create customer: POST /customers
  2. Generate setup link: POST /customers/:id/setup_links
  3. Customer completes embedded signup
  4. Use phone_number_id to send messages

Detect connection

Option A: Project webhook whatsapp.phone_number.created

Option B: Success redirect URL query params

Use both for best UX and backend reliability.

Provision phone numbers

When creating a setup link, set:

json
{
  "setup_link": {
    "provision_phone_number": true,
    "phone_number_country_isos": ["US"]
  }
}

Notes

  • Platform API base: /platform/v1
  • Meta proxy base: /meta/whatsapp/v24.0 (use for messaging and templates)
  • Use phone_number_id as the primary WhatsApp identifier

References

Related skills

  • kapso-automation - Workflow automation
  • whatsapp-messaging - WhatsApp messaging and templates
  • whatsapp-flows - WhatsApp Flows
  • kapso-ops - Operations and webhooks