文档_云片

Audio CAPTCHA Sending

Functional Description

Will call the user mobile and play the Audio CAPTCHA. It can play up to twice. For example, "您的验证码是1234". We already have the default template.

Report your qualification, SMS signature and SMS template to us. Please contact with us if need help.

We suggest to use the API "Audio CAPTCHA Sending".

HTTP Header:

Accept: application/json;charset=utf-8;
Content-Type:application/x-www-form-urlencoded;charset=utf-8;

URL: https://voice.yunpian.com/v2/voice/send.json

Function Description:

Will call the user mobile and play the Audio CAPTCHA. It can play up to twice. For example, "您的验证码是1234". We already have the default template.

Harassment Prevention:

This function is open by default.

Rule: The same content can only be send once in 30 seconds to the same mobile number. No more than 3 times in 5 minutes.

p.s. When the API is encrypted, the mobile number and the verification code should be encrypted at the same time.

Method: POST

Request Parameter:

PARAMETER	TYPE	REQUIRED	DESCRIPTION	EXAMPLE
apikey	string	Yes	APIKEY is credentials you can find on the "Account Dashboard" page. It is the string of 32-bit characters.	9b11127a9701975c734b8aee81ee3526
mobile	string	Yes	The destination phone number.	15205201314 01088880000
code	string	Yes	Verification code. We support 4 to 6 Arabic numerals.	1234
callback_url	string	No	If you pass this parameters, will push the audio CAPTCHA status records for this records to this URL address. If the push address is fixed, it is recommended to make the batch setting in "Data Push and Get".	`http://your_receive_url_address`
display_num	string	No	Calling number. In order to ensure the nationwide call success rate. We will select the best line automatically. The calling number will be changed.	"12345678"

JSON representations:

{
    "count": 1,
    "fee": 1,
    "sid": "931ee0bac7494aab8a422fff5c6be3ea"
}

ResponseParameter:

PARAMETER	TYPE	DESCRIPION	EXAMPLE
count	integer	Count	1
fee	integer	Deduction amount	1
sid	string	Record id, 32-bit string	"931ee0bac7494aab8a422fff5c6be3ea"

To get better effect, it is recommended to use together with SMS.

Connect to our US server
The address for US server us.yunpian.com. Replace "sms.yunpian.com" with "us.yunpian.com".