接口API以REST方式设计，为保证安全性，所有消息交互均以HTTPS方式交互。

所有文档中接口有相同的Base URL，当前为：http://www.iamyun.net/api

业务URL格式：Base URL与业务URL相拼接为完整请求URL，消息参数及返回内容目前只接受json格式。

HTTP消息头：

Accept:application/json;charset=utf-8;

Content-Type:application/json;charset=utf-8;

必须在用户页面编辑好验证码模板，模板参数最大允许8个字符，同时填入参数后，

全部语音拼接后最大时长不应超过30秒。验证码内容将以语音呼叫形式发送到用户手机。

语音验证码发送URL：http://www.iamyun.net/api/validate/voiceout

HTTP方法：POST

用户注册后登录页面，可以在用户中心看到自己的UID和access token，在所有HTTP请求头中，必须带上此token，如：

Token : xxxxxxxxxxxxxxxxx

用户可以在后续使用中，从页面选择刷新此token，刷新token后，API 调用中的token必须使用新token，原有token自动失效。

为了进一步提高请求安全性，用户可以选择在帐户IP白名单中增加指定IP，只有在白名单中的IP允许访问API。

参数名	类型	必选	说明	示例
to	string	是	接收手机号，仅允许单个手机号	13012345678
template_id	string	是	验证码模板号	23
arg	string	否	对应模板中参数	1234
report_url	string	否	状态报告发送地址	http://www.example.com/report/

字段名	类型	说明	示例
status	string	调用状态	0
desc	string	状态说明	成功
msg_id	string	验证码消息ID	abcdefghijklmn
call_num	string	呼出号码，应用应在页面上提示用户呼叫此号码	0571-87654321

POST /validate/voiceout

{“to”: “13012345678”, “template_id”: “23”, “arg”: “1234” }

HTTP/1.1 200 OK

{“status”: “0”, “desc”: “成功”, “msg_id”: “abcd1234efgh” , “call_num”: “0571-87654321”}

正在维护更新中...

正在维护更新中...

正在维护更新中...

# coding: utf-8

import requests

# 基地址

base_url = "http://10.8.23.79:8080/iamyun"

# API接口

req_url = base_url + "/validate/voiceout"

# HTTP头， 接收JSON格式

headers = {"Content-Type": "application/json;charset=UTF-8"}

# HTTP头中添加访问Token

headers["Token"] = "123456"

# 构造API参数

post_data = {"to": "13018956699", "template_id": "1", "arg": "123456"}

# 以json格式POST到服务器

result = requests.post(req_url, json=post_data, headers=headers)

# 得到结果

print result.content

#!/usr/bin/env bash

curl -X POST 'http://10.8.23.79:8080/iamyun/validate/voiceout'\

--header "Content-Type:application/json;charset=utf-8;"\

--header "Token: 12345y6"\

-d '{"to": "13588701622", "template_id": "1", "arg": "1234"}'

using System;

using System.IO;

using System.Net;

using System.Text;

static class Program

{static void Main()

{

// 基地址

string base_url = "http://10.8.23.96:8080/iamyun";

// 短信API地址

string req_url = base_url + "/validate/voiceout";

// 创建请求

HttpWebRequest request = (HttpWebRequest)WebRequest.Create(req_url);

// 请求方法为POST

request.Method = "POST";

// ContentType必须为json

request.ContentType = "application/json;charset=UTF-8";

// 添加Token

request.Headers.Add("Token", "123456");

// 得到请求数据流并添加json格式的post数据，必须是UTF-8编码

Stream myRequestStream = request.GetRequestStream();

StreamWriter myStreamWriter = new StreamWriter(myRequestStream, Encoding.GetEncoding("utf-8"));

string postDataStr = "{\"to\": \"13018956699\", \"template_id\": \"1\", \"arg\": \"1234\"}";

myStreamWriter.Write(postDataStr);

myStreamWriter.Close();

// 得到返回内容

HttpWebResponse response = (HttpWebResponse)request.GetResponse();

Stream myResponseStream = response.GetResponseStream();

StreamReader myStreamReader = new StreamReader(myResponseStream, Encoding.GetEncoding("utf-8"));

string retString = myStreamReader.ReadToEnd();

// 关闭流，并打印内容结果

myStreamReader.Close();

myResponseStream.Close();

Console.Write(response.Headers);

Console.Write(retString);

}

}

正在维护更新中...

错误码	说明
0	成功
1	接收号码不正确
2	帐户欠费
3	参数错误
999	未知错误