YesApi 接口文档

1501 阿里云发送短信接口

接口路径(新)：http://hn216.api.okayapi.com/api/App/Sms/AliyunSendSms

接口路径(旧)：http://hn216.api.okayapi.com/?s=App.Sms.AliyunSendSms

接口描述： 通过阿里云的SendSms发送短信，使用前请进入小白开放平台-阿里云短信配置。

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  • return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
PhoneNumbers字符串必须接收短信的手机号码。国内短信：11位手机号码，例如15951955195。国际/港澳台消息：国际区号+号码，例如85200000000。
SignName字符串必须短信签名名称。可在阿里云控制台签名管理页面签名名称一列查看。例如：阿里云
TemplateCode字符串必须短信模板ID。可在阿里云控制台模板管理页面模板CODE一列查看。例如：SMS_153055065
TemplateParam字符串JSON格式可选短信模板变量对应的实际值，JSON格式。例如：{"code":"1111"}

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例 
请求：
{你的接口域名}/?s=App.Sms.AliyunSendSmsPhoneNumbers=15988888888&SignName=小白开放平台&TemplateCode=SMS_153055065&TemplateParam={"name":"xxx"}&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "Message":"OK",
        "RequestId":"2184201F-BFB3-446B-B1F2-C746B7BF0657",
        "BizId":"197703245997295588^0",
        "Code":"OK"
    },
    "msg": "小白开放接口：App.Sms.AliyunSendSmsPhoneNumbers"
}

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.操作码，0成功，1失败err_code
data.BizId字符串发送回执ID，可根据该ID在接口QuerySendDetails中查询具体的发送状态。
data.Code字符串请求状态码。返回OK代表请求成功。其他错误码详见错误码列表。
data.Message字符串状态码的描述。
data.RequestId字符串请求ID。
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

1502 阿里云查看短信发送记录和发送状态

接口路径(新)：http://hn216.api.okayapi.com/api/App/Sms/AliyunQuerySendDetails

接口路径(旧)：http://hn216.api.okayapi.com/?s=App.Sms.AliyunQuerySendDetails

接口描述： 通过阿里云的QuerySendDetails接口查看短信发送记录和发送状态。使用前请进入小白开放平台-阿里云短信配置。

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  • return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
CurrentPage整型可选1最小：1分页查看发送记录，指定发送记录的的当前页码。
PageSize整型可选10最小：1；最大：50分页查看发送记录，指定每页显示的短信记录数量。取值范围为1~50。
PhoneNumber字符串必须接收短信的手机号码。格式：
  • 国内短信：11位手机号码，例如15900000000。
  • 国际/港澳台消息：国际区号+号码，例如85200000000。
SendDate字符串必须短信发送日期，支持查询最近30天的记录。格式为yyyyMMdd，例如20181225。

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例 
请求：
{你的接口域名}/?s=App.Sms.AliyunQuerySendDetails&CurrentPage=1&PageSize=10&PhoneNumber=15988888888&SendDate=20190913&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "TotalCount": 1,
        "Message": "OK",
        "RequestId": "A95CF705-FADF-4EA9-884E-BB2F31E85BB5",
        "SmsSendDetailDTOs": {
            "SmsSendDetailDTO": [
            {
                "SendDate": "2019-09-13 17:26:45",
                "SendStatus": 3,
                "ReceiveDate": "2019-09-13 17:26:51",
                "ErrCode": "DELIVERED",
                "TemplateCode": "SMS_174022468",
                "Content": "【小白开放平台】认证通知：尊敬的xxx，您的个人认证已经通过！",
                "PhoneNum": "15988888888"
            }
            ]
        },
        "Code": "OK"
    },
    "msg": "小白开放接口：App.Sms.AliyunQuerySendDetails"
}

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.操作码，0成功，1失败err_code
data.Code字符串请求状态码。返回OK代表请求成功。其他错误码详见错误码列表。
data.Message字符串状态码的描述。
data.RequestId字符串请求ID。
data.SmsSendDetailDTOs对象短信发送明细。
data.TotalCount字符串短信发送总条数。
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

1503 校验短信验证码

接口路径(新)：http://hn216.api.okayapi.com/api/App/Sms/CheckSmsCaptcha

接口路径(旧)：http://hn216.api.okayapi.com/?s=App.Sms.CheckSmsCaptcha

接口描述： 校验前请先购买并调用Supplier.YesApi.SendSmsCatpcha接口发送短信验证码。验证码将在15分钟内有效，可尝试5次，成功校验的失败。

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  • return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
mobile字符串必须最小：11；最大：11国内手机号，11位
code字符串必须最小：4；最大：64位到6位的数字验证码

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例 
// 请求
{你的接口域名}/?s=App.Sms.CheckSmsCaptcha&mobile=13800138000&code=1234&app_key={你的app_key}&sign={动态签名}

// 返回
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": ""
    },
    "msg": "小白开放接口：App.Sms.CheckSmsCaptcha"
}

// 成功后再次请求，则会提示失败，如：
{
    "ret": 200,
    "data": {
        "err_code": 1,
        "err_msg": "验证码不存在"
    },
    "msg": "小白开放接口：App.Sms.CheckSmsCaptcha"
}

补充，收到的验证码短信内容格式如下：
【YesApi】您的验证码${code}，该验证码15分钟内有效，请勿泄漏于他人！

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.操作码，0成功，1验证码不存在，2验证码已过期，3验证码已失效（失败次数过多），4验证码错误err_code
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

特别注意：当前 hn216.api.okayapi.com 为临时接口测试域名！请先完成 绑定独立接口域名后 ，才能正式进行API调用。

由 果创云YesApi.cn 提供技术支持，4万+开发者都在用，累计API调用1,800,000＋万次