一、接口说明 1. Interface description

反欺诈长短文本检测服务独立接口。 Anti-fraud long and short text detection service independent interface.

请注意：长短文本入参是相同的，只有path不一样。
Please note: the long and short text input parameters are the same, only the path is different.

Q：何时使用短文本？ Q: When to use short text?

A：一般而言，如果没有特殊需求配置，短文本的合理范围为0~100字，短文本能处理最大长度为200字。
A: Generally speaking, if there are no special requirements for configuration, the reasonable range of short text is 0~100 words, and the maximum length that short text can handle is 200 words.

Q：如果长文本使用短文本接口会怎么样？ Q: What happens if long text uses the short text interface?

A：网关会自动切换到长文本链路，会影响性能，同时影响关键词检测。建议：在100字范围内的文本走短文本接口，大于100字且小于2000个字的文本走长文本接口，这样检测结果更准确，接口性能最好。
A: The gateway will automatically switch to long text links, which will affect performance and keyword detection. Recommendation: Use the short text interface for texts within the range of 100 words, and use the long text interface for texts larger than 100 words and less than 2,000 words. This way, the detection results will be more accurate and the interface performance will be the best.

二、调用方式 2. Calling method

三、调用URL 3. Call URL

四、输入参数 4. Input parameters

4.1 头部参数 4.1 Header parameters

4.2 系统参数 4.2 System parameters

• 支持的事件类型 Supported event types

4.3 业务参数 4.3 Business parameters

• text 字段中可用字段 Available fields in the text field

五、输入示例 5. Input example

5.1. 输入demo样例 5.1. Enter demo sample

POST https://dapi.tongdun.cn/content/text/v1
head
    x-access-key: xx
    x-secret-key: xx
POST DATA:
       event_id=xxx&
       app_name=xxx&
       event_type=xxx&
       text={"msg_content":"弹幕内容","posting_content":"发帖内容","posting_title":"发帖标题","posting_comment":"回帖内容","comment_content":"sign","nickname":"评论内容","xxx":"扩容文本内容"}

5.2. Java OkHttp

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
RequestBody body = RequestBody.create(mediaType, "app_name=应用名&event_id=事件ID&event_type=事件类型&ip_address=1.1.1.2&account_login=test1&text={\"msg_content\":\"弹幕内容\",\"posting_content\":\"发帖内容：15光溜溜裙子%26掀起来%26干周旋，习近平胸有成竹地步入社会，大胸胸有成竹地步胸有成竹地步入社会胸有成竹地步入社会入社会胸有成竹地步入社会其实不过就是从心里认为幸福是他至始至终的坚持，傻逼幸福来自于内在བོད་ཡིག加我q257890678奥巴马.光溜溜阳痿致幻剂~指环\",\"posting_title\":\"发帖标题\",\"posting_comment\":\"回帖内容\",\"comment_content\":\"sign\",\"nickname\":\"评论内容\",\"xxx\":\"扩容文本内容\"}");
Request request = new Request.Builder()
  .url("https://dapi.tongdun.cn/content/text/v1")
  .method("POST", body)
  .addHeader("x-access-key", "同盾分配的accessKey")
  .addHeader("x-secret-key", "同盾分配的secretKey")
  .addHeader("Content-Type", "application/x-www-form-urlencoded")
  .build();
Response response = client.newCall(request).execute();

5.3. php curl

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://dapi.tongdun.cn/content/text/v1',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => 'app_name=应用名&event_id=事件ID&event_type=事件类型&ip_address=1.1.1.2&account_login=test1&text=%7B%22msg_content%22%3A%22%E5%BC%B9%E5%B9%95%E5%86%85%E5%AE%B9%22%2C%22posting_content%22%3A%22%E5%8F%91%E5%B8%96%E5%86%85%E5%AE%B9%EF%BC%9A15%E5%85%89%E6%BA%9C%E6%BA%9C%E8%A3%99%E5%AD%90%26%E6%8E%80%E8%B5%B7%E6%9D%A5%26%E5%B9%B2%E5%91%A8%E6%97%8B%EF%BC%8C%E4%B9%A0%E8%BF%91%E5%B9%B3%E8%83%B8%E6%9C%89%E6%88%90%E7%AB%B9%E5%9C%B0%E6%AD%A5%E5%85%A5%E7%A4%BE%E4%BC%9A%EF%BC%8C%E5%A4%A7%E8%83%B8%E8%83%B8%E6%9C%89%E6%88%90%E7%AB%B9%E5%9C%B0%E6%AD%A5%E8%83%B8%E6%9C%89%E6%88%90%E7%AB%B9%E5%9C%B0%E6%AD%A5%E5%85%A5%E7%A4%BE%E4%BC%9A%E8%83%B8%E6%9C%89%E6%88%90%E7%AB%B9%E5%9C%B0%E6%AD%A5%E5%85%A5%E7%A4%BE%E4%BC%9A%E5%85%A5%E7%A4%BE%E4%BC%9A%E8%83%B8%E6%9C%89%E6%88%90%E7%AB%B9%E5%9C%B0%E6%AD%A5%E5%85%A5%E7%A4%BE%E4%BC%9A%E5%85%B6%E5%AE%9E%E4%B8%8D%E8%BF%87%E5%B0%B1%E6%98%AF%E4%BB%8E%E5%BF%83%E9%87%8C%E8%AE%A4%E4%B8%BA%E5%B9%B8%E7%A6%8F%E6%98%AF%E4%BB%96%E8%87%B3%E5%A7%8B%E8%87%B3%E7%BB%88%E7%9A%84%E5%9D%9A%E6%8C%81%EF%BC%8C%E5%82%BB%E9%80%BC%E5%B9%B8%E7%A6%8F%E6%9D%A5%E8%87%AA%E4%BA%8E%E5%86%85%E5%9C%A8%E0%BD%96%E0%BD%BC%E0%BD%91%E0%BC%8B%E0%BD%A1%E0%BD%B2%E0%BD%82%E5%8A%A0%E6%88%91q257890678%E5%A5%A5%E5%B7%B4%E9%A9%AC.%E5%85%89%E6%BA%9C%E6%BA%9C%E9%98%B3%E7%97%BF%E8%87%B4%E5%B9%BB%E5%89%82~%E6%8C%87%E7%8E%AF%22%2C%22posting_title%22%3A%22%E5%8F%91%E5%B8%96%E6%A0%87%E9%A2%98%22%2C%22posting_comment%22%3A%22%E5%9B%9E%E5%B8%96%E5%86%85%E5%AE%B9%22%2C%22comment_content%22%3A%22sign%22%2C%22nickname%22%3A%22%E8%AF%84%E8%AE%BA%E5%86%85%E5%AE%B9%22%2C%22xxx%22%3A%22%E6%89%A9%E5%AE%B9%E6%96%87%E6%9C%AC%E5%86%85%E5%AE%B9%22%7D',
  CURLOPT_HTTPHEADER => array(
    'x-access-key: 同盾分配的accessKey',
    'x-secret-key: 同盾分配的secretKey',
    'Content-Type: application/x-www-form-urlencoded'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

5.4. Python requests

import requests

url = "https://dapi.tongdun.cn/content/text/v1"

payload='app_name=应用名&event_id=事件ID&event_type=事件类型&ip_address=1.1.1.2&account_login=test1&text=%7B%22msg_content%22%3A%22%E5%BC%B9%E5%B9%95%E5%86%85%E5%AE%B9%22%2C%22posting_content%22%3A%22%E5%8F%91%E5%B8%96%E5%86%85%E5%AE%B9%EF%BC%9A15%E5%85%89%E6%BA%9C%E6%BA%9C%E8%A3%99%E5%AD%90%26%E6%8E%80%E8%B5%B7%E6%9D%A5%26%E5%B9%B2%E5%91%A8%E6%97%8B%EF%BC%8C%E4%B9%A0%E8%BF%91%E5%B9%B3%E8%83%B8%E6%9C%89%E6%88%90%E7%AB%B9%E5%9C%B0%E6%AD%A5%E5%85%A5%E7%A4%BE%E4%BC%9A%EF%BC%8C%E5%A4%A7%E8%83%B8%E8%83%B8%E6%9C%89%E6%88%90%E7%AB%B9%E5%9C%B0%E6%AD%A5%E8%83%B8%E6%9C%89%E6%88%90%E7%AB%B9%E5%9C%B0%E6%AD%A5%E5%85%A5%E7%A4%BE%E4%BC%9A%E8%83%B8%E6%9C%89%E6%88%90%E7%AB%B9%E5%9C%B0%E6%AD%A5%E5%85%A5%E7%A4%BE%E4%BC%9A%E5%85%A5%E7%A4%BE%E4%BC%9A%E8%83%B8%E6%9C%89%E6%88%90%E7%AB%B9%E5%9C%B0%E6%AD%A5%E5%85%A5%E7%A4%BE%E4%BC%9A%E5%85%B6%E5%AE%9E%E4%B8%8D%E8%BF%87%E5%B0%B1%E6%98%AF%E4%BB%8E%E5%BF%83%E9%87%8C%E8%AE%A4%E4%B8%BA%E5%B9%B8%E7%A6%8F%E6%98%AF%E4%BB%96%E8%87%B3%E5%A7%8B%E8%87%B3%E7%BB%88%E7%9A%84%E5%9D%9A%E6%8C%81%EF%BC%8C%E5%82%BB%E9%80%BC%E5%B9%B8%E7%A6%8F%E6%9D%A5%E8%87%AA%E4%BA%8E%E5%86%85%E5%9C%A8%E0%BD%96%E0%BD%BC%E0%BD%91%E0%BC%8B%E0%BD%A1%E0%BD%B2%E0%BD%82%E5%8A%A0%E6%88%91q257890678%E5%A5%A5%E5%B7%B4%E9%A9%AC.%E5%85%89%E6%BA%9C%E6%BA%9C%E9%98%B3%E7%97%BF%E8%87%B4%E5%B9%BB%E5%89%82~%E6%8C%87%E7%8E%AF%22%2C%22posting_title%22%3A%22%E5%8F%91%E5%B8%96%E6%A0%87%E9%A2%98%22%2C%22posting_comment%22%3A%22%E5%9B%9E%E5%B8%96%E5%86%85%E5%AE%B9%22%2C%22comment_content%22%3A%22sign%22%2C%22nickname%22%3A%22%E8%AF%84%E8%AE%BA%E5%86%85%E5%AE%B9%22%2C%22xxx%22%3A%22%E6%89%A9%E5%AE%B9%E6%96%87%E6%9C%AC%E5%86%85%E5%AE%B9%22%7D'
headers = {
  'x-access-key': '同盾分配的accessKey',
  'x-secret-key': '同盾分配的secretKey',
  'Content-Type': 'application/x-www-form-urlencoded'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

5.5. Go http

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://dapi.tongdun.cn/content/text/v1"
  method := "POST"

  payload := strings.NewReader("app_name=应用名&event_id=事件ID&event_type=事件类型&ip_address=1.1.1.2&account_login=test1&text=%7B%22msg_content%22%3A%22%E5%BC%B9%E5%B9%95%E5%86%85%E5%AE%B9%22%2C%22posting_content%22%3A%22%E5%8F%91%E5%B8%96%E5%86%85%E5%AE%B9%EF%BC%9A15%E5%85%89%E6%BA%9C%E6%BA%9C%E8%A3%99%E5%AD%90%26%E6%8E%80%E8%B5%B7%E6%9D%A5%26%E5%B9%B2%E5%91%A8%E6%97%8B%EF%BC%8C%E4%B9%A0%E8%BF%91%E5%B9%B3%E8%83%B8%E6%9C%89%E6%88%90%E7%AB%B9%E5%9C%B0%E6%AD%A5%E5%85%A5%E7%A4%BE%E4%BC%9A%EF%BC%8C%E5%A4%A7%E8%83%B8%E8%83%B8%E6%9C%89%E6%88%90%E7%AB%B9%E5%9C%B0%E6%AD%A5%E8%83%B8%E6%9C%89%E6%88%90%E7%AB%B9%E5%9C%B0%E6%AD%A5%E5%85%A5%E7%A4%BE%E4%BC%9A%E8%83%B8%E6%9C%89%E6%88%90%E7%AB%B9%E5%9C%B0%E6%AD%A5%E5%85%A5%E7%A4%BE%E4%BC%9A%E5%85%A5%E7%A4%BE%E4%BC%9A%E8%83%B8%E6%9C%89%E6%88%90%E7%AB%B9%E5%9C%B0%E6%AD%A5%E5%85%A5%E7%A4%BE%E4%BC%9A%E5%85%B6%E5%AE%9E%E4%B8%8D%E8%BF%87%E5%B0%B1%E6%98%AF%E4%BB%8E%E5%BF%83%E9%87%8C%E8%AE%A4%E4%B8%BA%E5%B9%B8%E7%A6%8F%E6%98%AF%E4%BB%96%E8%87%B3%E5%A7%8B%E8%87%B3%E7%BB%88%E7%9A%84%E5%9D%9A%E6%8C%81%EF%BC%8C%E5%82%BB%E9%80%BC%E5%B9%B8%E7%A6%8F%E6%9D%A5%E8%87%AA%E4%BA%8E%E5%86%85%E5%9C%A8%E0%BD%96%E0%BD%BC%E0%BD%91%E0%BC%8B%E0%BD%A1%E0%BD%B2%E0%BD%82%E5%8A%A0%E6%88%91q257890678%E5%A5%A5%E5%B7%B4%E9%A9%AC.%E5%85%89%E6%BA%9C%E6%BA%9C%E9%98%B3%E7%97%BF%E8%87%B4%E5%B9%BB%E5%89%82~%E6%8C%87%E7%8E%AF%22%2C%22posting_title%22%3A%22%E5%8F%91%E5%B8%96%E6%A0%87%E9%A2%98%22%2C%22posting_comment%22%3A%22%E5%9B%9E%E5%B8%96%E5%86%85%E5%AE%B9%22%2C%22comment_content%22%3A%22sign%22%2C%22nickname%22%3A%22%E8%AF%84%E8%AE%BA%E5%86%85%E5%AE%B9%22%2C%22xxx%22%3A%22%E6%89%A9%E5%AE%B9%E6%96%87%E6%9C%AC%E5%86%85%E5%AE%B9%22%7D")

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("x-access-key", "同盾分配的accessKey")
  req.Header.Add("x-secret-key", "同盾分配的secretKey")
  req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

六、输出示例 6. Output example

{
    "final_score": 60,
    "policy_set_name": "批量测试工具专用",
    "risk_type": "suspiciousBarrage_reject",
    "final_decision": "Reject",
    "policy_set": [
        {
            "policy_score": 60,
            "policy_mode": "Weighted",
            "risk_type": "suspiciousBarrage",
            "policy_decision": "Reject",
            "policy_name": "文本测试",
            "policy_uuid": "0770ce8147c54b038b49c28df9bfd4b3",
            "hit_rules": [
                {
                    "score": 60,
                    "decision": "Accept",
                    "name": "弹幕内容包含不文明用语",
                    "id": "37113404",
                    "uuid": "4c6e2111333843658f3ddbc1b60508b1",
                    "parentUuid": ""
                }
            ]
        }
    ],
    "spend_time": 685,
    "success": true,
    "policy_name": "批量测试工具专用",
    "seq_id": "1553078290583293F797B4E7C7158736",
    "hit_rules": [
        {
            "score": 60,
            "decision": "Accept",
            "name": "弹幕内容包含不文明用语",
            "id": "37113404",
            "uuid": "4c6e2111333843658f3ddbc1b60508b1",
            "parentUuid": ""
        }
    ],
    "hit_keywords": [
        {
            "keyword": "命中的关键词"
        }
    ]
}

七、输出参数 7. Output parameters

7.1. 输出字段说明 7.1. Output field description

7.2. 命中策略字段policy_set说明 7.2. Description of hit policy field policy_set

7.3. hit_rules字段说明 7.3. Hit_rules field description

八、状态码说明 8. Status code description