Quick Start

This section is the entry point of the usage guide. The most essential steps are covered below; detailed console guides (balance top-up, billing queries, package management, callback configuration) are being prepared and will be published soon.

Step 1: Register and create an application

After registering in the console, go to "Applications" and create one. Each application has its own App ID and App Key, so you can separate business lines without interference.

Step 2: Purchase a package

Go to the "Purchase" page and pick the APIs and package type:

Package: deducts per call, renew when exhausted — fits low-frequency or small-volume usage

Buyout: pay once, use within the licensed scope (currently only Alipay Real-name)

Step 3: Make a call

Once you have the credentials, follow the About the Platform to send requests. The fastest way is to verify with curl:

curl -X POST https://yunsapi.com/api/v3/dxyzm \
  -H "X-APP-ID: YOUR_APP_ID" \
  -H "X-APP-KEY: YOUR_APP_KEY" \
  -H "Content-Type: application/json" \
  -d '{"phone":"13800138000"}'

A code of 0 in the response means success.

Notes

Always use HTTPS in production

Never expose App Key in front-end pages or public repositories

Billing rules differ per API; check the remaining quota before calling