淘宝开放平台 - 文档中心

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	更多限制	描述
tasks	Task []	可选		最大列表长度：999	系统自动生成
└ data_id String 可选 uuid-xxxx-xxxx-1234 数据ID └ image_url String 可选 http://xxx.xxx.com/xxx.jpg 待检测图像的URL。支持HTTP和HTTPS协议。当前仅支持上海地域的OSS链接 └ image_time Number 可选 1 图片创建或编辑时间 └ interval Number 可选 1 截帧频率 └ max_frames Number 可选 1 最大截帧数量
scenes	String []	可选	["porn"]	最大列表长度：999	场景列表

名称	类型	示例值	描述
taobao_request_id	String	2F187B01-FBFB-4A57-B51C-5E1B0FADE64D	请求ID
data_list	Data	{}	系统自动生成
results Result [] 结果图片检测结果 └ data_id String uuid-xxxx-xxx-1234 数据ID └ task_id String img4wlJcb7p4wH4lAP3111111-123456 任务ID └ image_url String http://xxx.xxx.xxx/xxx.jpg 图像的URL sub_results SubResult [] [{}] 单张图片的检测结果 └ suggestion String block 建议您执行的操作，取值范围： pass：图片正常，无需进行其余操作；或者未识别出目标对象 review：检测结果不确定，需要进行人工审核；或者识别出目标对象 block：图片违规，建议执行进一步操作（如直接删除或做限制处理） └ rate Number 99.63 相似概率 └ label String sexy 检测结果的分类，与具体的scene对应。取值范围参见scene和label说明。 └ scene String porn 图片检测场景，和调用请求中的场景（scenes）对应 └ ocr_data_list String [] [] 识别到的图片中的完整文字信息。说明默认不返回，如需返回请通过工单联系我们 frames Frame [] {} 如果待检测图片因为过长被截断，该参数返回截断后的每一帧图像的临时访问地址，供您参考。具体结构描述见Frame └ rate Number 0.5 置信度，仅作参考，不建议使用 └ u_r_l String http://xx.xxx.com/a.jpeg 被截断的图片的临时访问url，地址有效期是5分钟 hint_words_info_list HintWordsInfo [] [] 图片中含有广告时，返回图片中广告文字命中的风险关键词信息。格式为数组，具体结构描述见HintWordsInfo。说明仅适用于ad场景。示例值： "hintWordsInfo":[{"context":"敏感词"}] └ context String [{"context":"敏感词"}] 图片中文字命中的风险关键词内容 program_code_data_list ProgramCodeData [] [] 图片中含有小程序码时，返回小程序码的位置信息，具体结构描述见ProgramCodeData。说明仅适用于qrcode场景，且已通过工单联系我们开通了小程序码识别 └ x Number 100 以图片左上角为坐标原点，小程序码区域左上角到y轴距离 └ y Number 100 以图片左上角为坐标原点，小程序码区域左上角到x轴距离 └ width Number 100 小程序码区域宽度 └ height Number 100 小程序码区域高度 logo_data_list LogoData [] [] 图片中含有logo时，返回识别出来的logo信息，具体结构描述见LogoData。说明仅适用于logo场景 └ type String TV 识别出的logo类型，取值为TV （台标） └ name String xxx台识别出的logo名称 └ x Number 140 以图片左上角为坐标原点，logo区域左上角到y轴距离。 └ y Number 68 以图片左上角为坐标原点，logo区域左上角到x轴距离。 └ width Number 140 logo区域宽度 └ height Number 140 logo区域高度 sface_data_list SfaceData [] [] 图片中包含暴恐识涉政内容时，返回识别出来的暴恐涉政信息，具体结构描述见SfaceData。说明仅适用于terrorism和sface场景。关于该参数在sface场景中的具体内容，请参见敏感人脸检测 faces Face [] [] 识别出的人脸信息，具体结构描述见face └ id String AliFace_0001234 人脸Id └ rate Number 95 相似概率 └ name String 命中人名相似人物的名称 └ heihght Number 4 人脸区域高度 └ width Number 3 人脸区域宽度 └ y Number 2 以图片左上角为坐标原点，人脸区域左上角到x轴距离 └ x Number 1 以图片左上角为坐标原点，人脸区域左上角到y轴距离

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AliyunViapiImageauditScanimageRequest req = new AliyunViapiImageauditScanimageRequest();
List<AliyunViapiImageauditScanimageRequest.Task> list2 = new ArrayList<AliyunViapiImageauditScanimageRequest.Task>();
AliyunViapiImageauditScanimageRequest.Task obj3 = new AliyunViapiImageauditScanimageRequest.Task();
list2.add(obj3);
obj3.setDataId("uuid-xxxx-xxxx-1234");
obj3.setImageUrl("http://xxx.xxx.com/xxx.jpg");
obj3.setImageTime(1L);
obj3.setInterval(1L);
obj3.setMaxFrames(1L);
req.setTasks(list2);
req.setScenes(""porn"");
AliyunViapiImageauditScanimageResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AliyunViapiImageauditScanimageRequest req = new AliyunViapiImageauditScanimageRequest();
List<AliyunViapiImageauditScanimageRequest.TaskDomain> list2 = new List<AliyunViapiImageauditScanimageRequest.TaskDomain>();
AliyunViapiImageauditScanimageRequest.TaskDomain obj3 = new AliyunViapiImageauditScanimageRequest.TaskDomain();
list2.Add(obj3);
obj3.DataId = "uuid-xxxx-xxxx-1234";
obj3.ImageUrl = "http://xxx.xxx.com/xxx.jpg";
obj3.ImageTime = 1L;
obj3.Interval = 1L;
obj3.MaxFrames = 1L;
req.Tasks_ = list2;
req.Scenes = ""porn"";
AliyunViapiImageauditScanimageResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AliyunViapiImageauditScanimageRequest;
$tasks = new Task;
$tasks->data_id="uuid-xxxx-xxxx-1234";
$tasks->image_url="http://xxx.xxx.com/xxx.jpg";
$tasks->image_time="1";
$tasks->interval="1";
$tasks->max_frames="1";
$req->setTasks(json_encode($tasks));
$req->setScenes("[\"porn\"]");
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=aliyun.viapi.imageaudit.scanimage' \
-d 'partner_id=apidoc' \
-d 'sign=EC17FD1F50A783A36F4882B6E4C58E7B' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-06-08+13%3A29%3A10' \
-d 'v=2.0' \
-d 'scenes=%22porn%22' \
-d 'tasks=null'

# -*- coding: utf-8 -*-
import top.api

req=top.api.AliyunViapiImageauditScanimageRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.tasks=""
req.scenes="["porn"]"
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"aliyun.viapi.imageaudit.scanimage");
add_param(pRequest,"tasks","数据结构JSON示例");
add_param(pRequest,"scenes",""porn"");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('aliyun.viapi.imageaudit.scanimage', {
	'tasks':'数据结构JSON示例',
	'scenes':'"porn"'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<aliyun_viapi_imageaudit_scanimage_response>
    <taobao_request_id>2F187B01-FBFB-4A57-B51C-5E1B0FADE64D</taobao_request_id>
    <data_list>
        <results>
            <result>
                <data_id>uuid-xxxx-xxx-1234</data_id>
                <task_id>img4wlJcb7p4wH4lAP3111111-123456</task_id>
                <image_url>http://xxx.xxx.xxx/xxx.jpg</image_url>
                <sub_results>
                    <sub_result>
                        <suggestion>block</suggestion>
                        <rate>99.63</rate>
                        <label>sexy</label>
                        <scene>porn</scene>
                        <ocr_data_list>
                            <string>[]</string>
                        </ocr_data_list>
                        <frames>
                            <frame>
                                <rate>0.5</rate>
                                <u_r_l>http://xx.xxx.com/a.jpeg</u_r_l>
                            </frame>
                        </frames>
                        <hint_words_info_list>
                            <hint_words_info>
                                <context>[{&quot;context&quot;:&quot;敏感词&quot;}]</context>
                            </hint_words_info>
                        </hint_words_info_list>
                        <program_code_data_list>
                            <program_code_data>
                                <x>100</x>
                                <y>100</y>
                                <width>100</width>
                                <height>100</height>
                            </program_code_data>
                        </program_code_data_list>
                        <logo_data_list>
                            <logo_data>
                                <type>TV</type>
                                <name>xxx台</name>
                                <x>140</x>
                                <y>68</y>
                                <width>140</width>
                                <height>140</height>
                            </logo_data>
                        </logo_data_list>
                        <sface_data_list>
                            <sface_data>
                                <faces>
                                    <face>
                                        <id>AliFace_0001234</id>
                                        <rate>95</rate>
                                        <name>命中人名</name>
                                    </face>
                                </faces>
                                <heihght>4</heihght>
                                <width>3</width>
                                <y>2</y>
                                <x>1</x>
                            </sface_data>
                        </sface_data_list>
                    </sub_result>
                </sub_results>
            </result>
        </results>
    </data_list>
</aliyun_viapi_imageaudit_scanimage_response>

{
    "aliyun_viapi_imageaudit_scanimage_response":{
        "taobao_request_id":"2F187B01-FBFB-4A57-B51C-5E1B0FADE64D",
        "data_list":{
            "results":{
                "result":[
                    {
                        "data_id":"uuid-xxxx-xxx-1234",
                        "task_id":"img4wlJcb7p4wH4lAP3111111-123456",
                        "image_url":"http:\/\/xxx.xxx.xxx\/xxx.jpg",
                        "sub_results":{
                            "sub_result":[
                                {
                                    "suggestion":"block",
                                    "rate":99.63,
                                    "label":"sexy",
                                    "scene":"porn",
                                    "ocr_data_list":{
                                        "string":[
                                            "[]"
                                        ]
                                    },
                                    "frames":{
                                        "frame":[
                                            {
                                                "rate":0.5,
                                                "u_r_l":"http:\/\/xx.xxx.com\/a.jpeg"
                                            }
                                        ]
                                    },
                                    "hint_words_info_list":{
                                        "hint_words_info":[
                                            {
                                                "context":"[{\"context\":\"敏感词\"}]"
                                            }
                                        ]
                                    },
                                    "program_code_data_list":{
                                        "program_code_data":[
                                            {
                                                "x":100,
                                                "y":100,
                                                "width":100,
                                                "height":100
                                            }
                                        ]
                                    },
                                    "logo_data_list":{
                                        "logo_data":[
                                            {
                                                "type":"TV",
                                                "name":"xxx台",
                                                "x":140,
                                                "y":68,
                                                "width":140,
                                                "height":140
                                            }
                                        ]
                                    },
                                    "sface_data_list":{
                                        "sface_data":[
                                            {
                                                "faces":{
                                                    "face":[
                                                        {
                                                            "id":"AliFace_0001234",
                                                            "rate":95,
                                                            "name":"命中人名"
                                                        }
                                                    ]
                                                },
                                                "heihght":4,
                                                "width":3,
                                                "y":2,
                                                "x":1
                                            }
                                        ]
                                    }
                                }
                            ]
                        }
                    }
                ]
            }
        }
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

开放平台

视觉开放API(viapi)

aliyun.viapi.imageaudit.scanimage (绿网-内容安全)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ