业务方接口定义
0.1. 检测送审接口
1、检测API
请求url https://eco.immomo.com/api/check/send
请求方式 POST
请求参数 | 是否必须 | 类型 | 备注 |
---|---|---|---|
appid | 必须 | string | 每个业务分配的具体appid |
sign | 必须 | string | sha1(appid.content) 说明:appid和content做完字符串拼接,然后对新字符串做sha1 |
content | 必须 | string | 按指定规则生成的加密串 参数数组先json_encode,过aes加密,再base64_encode |
content 解密出来字段
请求参数 | 是否必须 | 类型 | 备注 |
---|---|---|---|
timestamp | 必须 | string | 签名生效时间,格式为13位时间戳字符串,默认值为当前时间戳,参与签名校验 |
category | 必须 | string | 场景key,自定义配置 |
detail | 必须 | array | text(文本系列 最多10条文本,每条最多500字) image(图片系列 上限16张) video(视频url系列) audio(音频url系列) |
uniqid | 非必须 | sting | 业务方自定义唯一id |
spam_id | string | 否 | 用于spam信息的标识,非必传(通常传用户id) |
redirect | 非 | string | urlencode($url) 仅包含文本无需回调地址,其他需要回调才填, |
source | 若包含视频类型则必须 | string | 视频source(具体联系开发) |
备注:detail格式(需要送审的内容填入即可)
字段 | 类型 | 是否必填(送检某业务必填某字段) | 备注 |
---|---|---|---|
text | array | 否 | 文本系列 最多10条文本,每条最多250字(key => value) |
image | array | 否 | 图片url系列 上限16张 |
video | array | 否 | 视频url系列 上限1条(key => value)视频格式见下例 |
audio | array | 否 | 音频url系列 上限1条(key => value) |
例:
{// 按实际需求传递数据,文本传到text字段里,图片传到image字段里,其他依次一样,没有就不传
"text": [
"xxx",
"xxx"
],
"image": [
"xxx",
"xxx"
],
"video":[
// 备注 陌陌平台(source=pivot)访问 http://pivot-dispatcher.momo.com${uri}
// 其他项目的访问 http://pivot-transcoder.momo.com/dispatcher/${source}${uri}
"xxx",
"xxx"
],
"audio":[
"xxx",
"xxx"
]
}
2、输出返回值
名称 | 类型 | 描述 |
---|---|---|
ec | int | 状态码 |
em | string | 提示信息 |
data | string | 送检同样加密方式的返回数据 |
备注:
data返回解密后内容说明
名称 | 类型 | 描述 |
---|---|---|
is_real_time | int | 是否实时返回 1:实时,0非实时走回调 |
ticket_id | string | 工单id 分配的工单唯一id |
uniqid | string | 业务方传入唯一id |
result | string | 返回结果 最终返回给用户的模型检测结果(非实时不参考此结果,以回调为准) |
result_score | float | 返回结果的信心率 最终返回给用户的检测结果信心率(非实时不参考此结果,以回调为准) |
appid | string | appid |
category | string | 场景key |
错误码 详情参考
3、正确返回
{
ec: xxx,
em: xxx,
data: content(加密后内容)
}
解密后格式:content
{
is_real_time:x,
ticket_id:xxx,
uniqid:xxx,
appid:xxx,
category:xxx,
result:xxx,
result_score:xxx,
}
4、错误返回
{
ec: 错误码,
em: 错误信息,
date: content(加密后内容)
}
解密后ccontent:
{
uniqid:xxx,
category:xxx,
}