有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: acp.tencentcloudapi.com 。

创建应用合规隐私诊断任务

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateAppScanTask。
Version String 公共参数,本接口取值:2022-01-05。
Region String 公共参数,本接口不需要传递此参数。
TaskType Integer 任务类型, 0:基础版, 1:专家版, 2:本地化
示例值:0
Source Integer 任务来源, 0:小程序诊断, 1:预留字段(暂未使用), 2:app诊断(android), 3:app漏洞扫描;
示例值:2
Platform Integer 应用平台, 0:android, 1:ios, 2:小程序
示例值:0
AppPackage String App包名
示例值:com.test.app
AppName String App名称(任务来源为2时必填)
示例值:测试App
AppVersion String App版本
示例值:v1.0
FileID String 上传的软件文件ID(任务来源为1时必填)
示例值:673d29c2f70b40c18d88**141
AppDownloadUrl String 软件下载链接地址(任务来源为2时必填)
示例值:https://bma-privacy****.apk
PrivacyTextUrl String 隐私文本下载地址(任务来源为2时必填)
示例值:https://bma-privacy****.txt
ContactName String 联系人信息
示例值:王某
TelNumber String 联系电话
示例值:13800138000
Email String 公司邮箱
示例值:testApp@test.com
CorpName String 公司名称
示例值:App测试有限公司
SalesPerson String 商务对接人员
示例值:张三
Remark String 备注信息
示例值:备注信息
IsAgreePrivacy Integer 是否同意隐私条款,0:不同意(默认), 1:同意
示例值:1
PrivacyTextName String 隐私申明文件名称
示例值:隐私申明文本.txt
AppSha1 String 软件Sha1值(PrivacyTextMD5不为空时必填)
示例值:软件Sha1值
PrivacyTextMD5 String 隐私申明文本md5(AppSha1不为空时必填)
示例值:隐私申明文本md5

3. 输出参数

参数名称 类型 描述
Result Integer 返回值, 0:成功, 其他值请查看“返回值”定义
示例值:0
TaskID String 任务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:170143813***360
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建App隐私合规基础诊断任务

输入示例

POST / HTTP/1.1
Host: acp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAppScanTask
<公共请求参数>

{
    "AppPackage": "com.test.app",
    "Source": "2",
    "Platform": "0",
    "TaskType": "0"
}

输出示例

{
    "Response": {
        "RequestId": "xxxxxx",
        "Result": 0,
        "TaskID": "170143813*******360"
    }
}

示例2 创建小程序基本检测任务

输入示例

POST / HTTP/1.1
Host: acp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAppScanTask
<公共请求参数>

{
    "Platform": "2",
    "Source": "0",
    "AppPackage": "wxe***97c684",
    "TaskType": "0"
}

输出示例

{
    "Response": {
        "RequestId": "6d9fc265-a647-4f3c-b188-3b98e064e905",
        "Result": 0,
        "TaskID": "267***400"
    }
}

示例3 本地化任务

输入示例

POST / HTTP/1.1
Host: acp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAppScanTask
<公共请求参数>

{
    "Remark": "备注信息啦",
    "Platform": "0",
    "TelNumber": "10086",
    "Source": "2",
    "SalesPerson": "张三",
    "ContactName": "老王",
    "TaskType": "2",
    "CorpName": "测试有限公司",
    "Email": "test@test.com",
    "IsAgreePrivacy": "1"
}

输出示例

{
    "Response": {
        "RequestId": "6c296e5b-48ad-4cfb-a90d-8010c9951341",
        "Result": 0,
        "TaskID": "271***520"
    }
}

示例4 App专家版隐私合规诊断示例

输入示例

POST / HTTP/1.1
Host: acp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAppScanTask
<公共请求参数>

{
    "PrivacyTextName": "腾讯iOA隐私保护指引.txt",
    "AppDownloadUrl": "https://bm****OYpo8YKRrbnTofaB.apk",
    "Platform": "0",
    "TelNumber": "10086",
    "AppName": "ioa",
    "PrivacyTextUrl": "https://bm****jc7yrar9xIKPYyvpEgVA.txt",
    "AppPackage": "com.***.i**oa",
    "Source": "2",
    "SalesPerson": "张三",
    "ContactName": "老王",
    "TaskType": "1",
    "CorpName": "测试有限企业",
    "Email": "test@test.com",
    "IsAgreePrivacy": "1"
}

输出示例

{
    "Response": {
        "RequestId": "ab653763-5494-42db-b7d3-4afd9eb76410",
        "Result": 0,
        "TaskID": "271***344"
    }
}

示例5 App自动化版隐私合规诊断示例

输入示例

POST / HTTP/1.1
Host: acp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAppScanTask
<公共请求参数>

{
    "PrivacyTextName": "腾讯iOA隐私保护指引.txt",
    "AppDownloadUrl": "https://bm***8YKRrbnTofaB.apk",
    "Platform": "0",
    "TelNumber": "10086",
    "AppName": "ioa",
    "PrivacyTextUrl": "https://bm****cxjc7yrar9xIKPYyvpEgVA.txt",
    "AppPackage": "com.***.i**oa",
    "Source": "2",
    "SalesPerson": "张三",
    "ContactName": "老王",
    "TaskType": "0",
    "CorpName": "测试有限企业",
    "Email": "test@test.com",
    "IsAgreePrivacy": "1"
}

输出示例

{
    "Response": {
        "RequestId": "4a9ed2aa-a7a9-4a29-90dc-235d8ee83040",
        "Result": 0,
        "TaskID": "271****296"
    }
}

示例6 提交漏洞扫描app任务

输入示例

POST / HTTP/1.1
Host: acp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAppScanTask
<公共请求参数>

{
    "Platform": "0",
    "Source": "3",
    "AppDownloadUrl": "https://bm***berJdezPIV926.apk",
    "TaskType": "0"
}

输出示例

{
    "Response": {
        "RequestId": "0b496234-892d-4f58-8261-9eb7ac3062a9",
        "Result": 0,
        "TaskID": "347***496"
    }
}

示例7 提交app隐私诊断任务(appSha1和隐私文本md5值)

输入示例

POST / HTTP/1.1
Host: acp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAppScanTask
<公共请求参数>

{
    "PrivacyTextName": "隐私文本.txt",
    "AppSha1": "fbcb5873fedaeec4f4c2d2d09be117eb",
    "Source": "2",
    "AppName": "测试app",
    "PrivacyTextUrl": "https://privacy.e.qq.com/inner?appid",
    "Platform": "0",
    "PrivacyTextMD5": "a8c8890dec7496ef0514a976a984a1c7",
    "AppDownloadUrl": "https://union.gdtimg.com/apk/unionAppPkg/fbcb5873fedaeec4f4c2d2d09be117eb.apk",
    "TaskType": "0"
}

输出示例

{
    "Response": {
        "RequestId": "8bf4b3***5500e49fb8",
        "Result": 0,
        "TaskID": "357***816"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。