小影API 小影API

SMS Verification

SMS verification code capability: sending and verification via Aliyun phone number authentication, with codes generated/validated server-side to prevent SMS bombing. The Aliyun channel is currently integrated.

/api/sms_verify/

Service Description

The SMS verification service is built on Alibaba Cloud phone-number authentication, with the server generating, sending and checking codes: call the send API to deliver a code to a mobile number, then call the check API once the user enters it to see whether it is correct or has expired.

Integrators can configure the code length, validity period, duplicate-send policy and throttling interval (60 seconds by default) to prevent SMS abuse. Verification happens on Alibaba Cloud's side, so you do not need to store or compare codes yourself.

All endpoints require project signature authentication, and the request body must be an application/x-www-form-urlencoded form rather than a JSON body.

Response Format

Every endpoint returns the same JSON envelope; the payload is always inside data: 

{
  "code": 10000,
  "msg": "成功",
  "data": { ... }
}
  • code: business status code. 10000 means success; anything else is an error — see the Error Codes page for the full list.
  • msg: a human-readable message you can show to end users, but never use it for program logic.
  • data: the payload; usually null on error. Each endpoint's Response section lists its data fields.

Judge success by code, not by the HTTP status code. View all error codes

Under Maintenance This service is currently in "Under Maintenance" status, the API may be temporarily unavailable. The docs and debug below are for reference only.

Aliyun SMS Verification Code

Aliyun Phone Number Authentication Service (Dypnsapi) Signature Required

Verification codes are dynamically generated and verified by the Aliyun system; all APIs require the project Signature to prevent SMS abuse.

POST /api/sms_verify/aliyun/send Total calls: 0

Send SMS Verification Code

Send an SMS verification code to the specified phone number; the validity period, rate limit interval and more are configurable.

11-digit phone number (Required)

Optional: 4-8, Default 4

Optional: verification code validity period, Default 300 seconds (5 minutes)

Optional: Default 1 (overwrite the old code)

Optional: rate limit interval, Default 60 seconds (anti SMS bombing)

Optional: 1-7 (1 = digits only), Default 1

Optional: enable true only for testing, so you can retrieve the code directly for verification

Optional: leave empty to use the Aliyun default scheme

Optional: external transaction ID (passed through in the response)

  • The request body is an application/x-www-form-urlencoded form; this service requires the project Signature (app_id/timestamp/nonce/sign).
  • A successful send returns code=10000; when the rate limit is triggered, the response asks you to wait (interval seconds) before retrying.
Response Common envelope
Field Type Description
biz_id string Alibaba Cloud send transaction ID
out_id string External serial number (passed through)
verify_code string Verification code; present only when returning it is enabled
Example response 
{"biz_id": "9006197469364984400", "out_id": "", "verify_code": ""}
POST /api/sms_verify/aliyun/check Total calls: 0

Verify SMS Verification Code

Verify whether the verification code entered by the user is correct or has expired.

11-digit phone number (Required)

Verification code received on the phone (Required)

Optional: Default 1 (case-insensitive)

Optional: must match the value used when sending the code; leave empty to use the default scheme

Optional: external transaction ID (passed through in the response)

  • A successful API request always returns code=10000; the business result is determined by data.verify_result:
  • PASS = verification succeeded, UNKNOWN = verification failed (wrong or expired verification code).
Response Common envelope
Field Type Description
verify_result string Verification result: PASS/UNKNOWN
passed bool Whether verification passed
out_id string External serial number (passed through)
Example response 
{"verify_result": "PASS", "passed": true, "out_id": ""}
XiaoYingAPI · Unified API Aggregation Service