Developer docs

Quick start

1. 1

   Step 1 · Get credentials

   After signing up, create access credentials in the console. Start with a sandbox test credential for integration.

2. 2

   Step 2 · Prepare a template

   Use a ready-made system template, or create a custom one (usable once reviewed).

3. 3

   Step 3 · Send your first message

   Call the unified send API with message type, template and recipient. Requests are lists; a single send is a list of length 1.

4. 4

   Step 4 · Get results

   Learn delivery status in real time via result callbacks, or query by message ID.

5. 5

   Step 5 · Verify in sandbox first

   Use sandbox credentials with magic numbers to simulate delivery, failure and timeout — all at zero cost.

curl -X POST https://<api-endpoint>/v1/messages \
  -H "Authorization: <signature>" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [{
      "bizId": "your-unique-id-001",
      "channel_type": "sms",
      "message_type": "verification",
      "template_code": "TMPL_XXX",
      "signature_code": "SIG_XXX",
      "recipient": "+8613800138000",
      "variables": { "code": "123456" }
    }]
  }'

Integration for AI agents

Building an AI app? Let your agent call the platform as a tool, with no need to wrap the API yourself. Identity is bound via headers on session init.

• send_message: send messages (single or batch)
• query_message_status: query message status
• list_templates: list available templates
• get_balance: check balance and usage

On send_message's wait_for_final: it's a best-effort short poll. A timeout returning 'accepted' is normal, not a synchronous delivery guarantee.