7）Scroll创建接口 - 消息服务总线3.0在线接口文档

请求参数

Header 参数

appKey

string

AppKey

必需

nonce

string

随机数

必需

timestamp

string

时间戳

必需

signature

string

必需

签名，详见附件客户签名生成工具类

Body 参数application/json

Scroll创建入参

articleInfo

object (ArticleInfo)

发文相关信息

必需

searchMode

object (SearchMode)

可选

检索模式【如果searchType=0，keywordExps必填;如果searchType=1，simpleKeyword必填】

searchTime

object (SearchTime)

必需

搜索时间
注意：取决于realTime，如果自定义以传入开始和结束时间生效，非自定义，系统根据now字段计算。
startPubTime<=发文时间<endPubTime

dataSources

array[string]

可选

渠道/媒体类型,详见《字典接口模块》指定境内外类型查询媒体类型接口【取返回结果code字段值】

matchMethods

array[integer <int32>]

可选

匹配方式【默认文本匹配,1-文本(正文|标题)、2-OCR、3-语音、4-场景、5-人脸、6-标题、7-正文(内容)】

articleTypes

array[integer <int32>]

可选

数据类型【0-对话、1-原创、2-转发、3-评论】

ipAreaCountry

array[string]

可选

IP归属地所在国家,详见《字典接口模块》国家三字英文码值对照列表【取返回结果pek字段值】

ipAreaProvinces

array[string]

可选

IP归属地所在省,详见《字典接口模块》指定区域父级节点查询信息【取返回结果id字段值】

urls

array[string]

可选

发文链接【最多支持5个url】

insertTime

object (InsertTime)

数据入队列时间

可选

esInsertTime

object (EsInsertTime)

发文入ES时间

可选

signInAreas

array[object (SignInArea) {4}]

可选

签到地域信息,详见《字典接口模块》，各个字段取值详见字段说明

isPaid

integer <int32>

可选

是否付费,【空/-1默认全部、-1-全部、0-免费、1-付费】注意：付费数据是需开通权限，如果未开权限数据会返回空，免费数据默认都有。

>= -1<= 1

示例值:

-1

isAdvertisement

integer <int32>

可选

是否为广告数据【0-否、1-是】

>= -1<= 1

author

array[string]

可选

作者,最多支持20个(包含20，总长度300)

topicTags

array[string]

可选

话题标签,最多支持20个(包含20，总长度300)

mediaTypes

array[integer <int32>]

可选

发文类型【1-文本、2-图文、3-视频】

mediaTypeMatch

integer <int32>

可选

发文类型匹配关系【0-任意包含，1-必须包含】，默认为任意包含

rootArticleIds

array[string]

可选

根博文id集合【最多支持10个root_article_id】

articlePlatform

object (ArticlePlatform)

发文站点相关信息

可选

mediaInfos

array[object (MediaInfo) {10}]

可选

指定媒体组,注意：详见分页检索账号信息列表接口【如果是长文本的建议把接口返回的platform下所有字段对应传入，社交额外带上账号ID值，若单独指定渠道检索不生效(查询全部渠道)，若想生效请使用articleInfo.dataSources字段】

isForeignMedia

integer <int32>

可选

是否境内外媒体【0-境内、1-境外(外国媒体+港澳台媒体)、-1-境内外(全部)】

>= -1<= 1

示例值:

-1

country

array[string]

可选

媒体国家,详见《字典接口模块》国家三字英文码值对照列表【取返回结果pek字段值】,最多支持20个(包含20，总长度100)

mediaAreas

array[object (MediaArea) {3}]

可选

媒体地域信息,详见《字典接口模块》,各个字段取值详见字段说明

mediaTags

array[string]

可选

媒体标签,详见《字典接口模块》媒体信源标签信息列表【取返回结果tagName字段值】,最多支持20个(包含20，总长度100)注意：articlePlatform.mediaTags与articlePlatform.excludeMediaTags字段同时有值，articlePlatform.excludeMediaTags不会生效不能同时存在，其中一个可不传

excludeMediaTags

array[string]

可选

排除媒体标签,详见《字典接口模块》媒体信源标签信息列表【取返回结果tagName字段值】,最多支持20个(包含20，总长度100)注意：articlePlatform.mediaTags与articlePlatform.excludeMediaTags字段同时有值，articlePlatform.excludeMediaTags不会生效不能同时存在，其中一个可不传

articleUser

object (ArticleUser)

发文账号相关信息

可选

userIds

array[string]

可选

账号ID,最多支持20个(包含20，总长度300)

customIds

array[string]

可选

平台账号ID,最多支持20个(包含20，总长度300)

userNames

array[string]

可选

账号名称,最多支持20个(包含20，总长度300)

userSex

string

可选

账号博主性别，m：男 f：女

isVerified

integer <int32>

可选

是否账号认证,【空/-1默认全部、-1-全部、0-未认证、1-已认证】

>= -1<= 1

示例值:

-1

verifiedTypes

array[integer <int32>]

可选

认证类型【0-未认证、1-个人、2-机构组织、3-公司企业、4-其他】

fanRange

object (FanRange)

可选

粉丝数量范围入参【包头包尾】

userRegisterAreas

array[object (UserRegisterArea) {4}]

可选

账号注册地域信息,具体详见《字典接口模块》，各个字段取值详见字段说明

articleAnalysis

object (ArticleAnalysis)

发文分析相关信息

可选

languages

array[string]

可选

语种,详见《字典接口模块》ISO639语言编码信息列表【取返回结果code字段值】

categories

array[string]

可选

分类,详见《字典接口模块》分类列表查询【取返回结果categoryName字段值】,最多支持20个(包含20，总长度100)

polarities

array[integer <int32>]

可选

内容情感【0-中立、1-正面、2-负面】

isSensitive

integer <int32>

可选

是否敏感【为空默认全部，0-否、1-是】

>= 0<= 1

subjectSentiments

array[string]

可选

主体情感【格式：汉字-数字，数字只支持0-中立、1-正面、2-负面、3-无关、4-未知】

contentAreas

array[object (ContentArea) {4}]

可选

内容提及地域信息,各个字段取值详见字段说明

mediaGradeTags

array[object (MediaGradeTag) {7}]

可选

标签信息分类,各个字段取值详见字段说明

fingerprint

string

可选

语义指纹【用于对相似文章进行排重】

isFingerprintHead

integer <int32>

可选

语义指纹标记是否簇头【为空默认不构建,1-是、0-否】

>= 0<= 1

subjectExtract

array[string]

可选

提及人,最多支持20个(包含20，总长度100)

contentClassify

array[string]

内容分类

可选

areaType

string

可选

IP归属地所在国家+IP归属地所在省+内容提及地域信息+媒体国家+媒体地域信息+账号注册地域信息+签到地域信息构建关系【默认AND关系,1-AND、2-OR】

示例值:

hiddenMark

object (HiddenMark)

可选

发文显隐标记信息注意：hideMarkId和isHidden两个字段都不为空，才会生效

hideMark

string

可选

隐藏字段标识【格式：用户ID-方案ID】

正则匹配:

^\d{1,11}-\d{1,11}$

isHidden

boolean

可选

是否显示剔除内容【true-显示剔除内容、false-不显示剔除内容】

accountMatchDTO

object (AccountMatch)

可选

自定义匹配方式入参注意：支持根据站点名称、账号名称等六个字段进行检索明确需求，需要用到哪些字段，匹配的字段越少越好，否则浪费系统资源！账号匹配方式matchType可以对输入的关键词进行精确匹配或模糊匹配默认操作符defaultOperator可以决定不同关键词间的关系是and或or

matchType

integer <int32>

可选

账号匹配方式【0-精确匹配、1-模糊匹配】

>= 0<= 1

示例值:

defaultOperator

integer <int32>

可选

默认操作符【空/0默认AND、1-OR】

>= 0<= 1

示例值:

websiteNames

string

可选

站点名称【支持关键词长度最大100】

subWebsiteNames

string

可选

子站点名称【支持关键词长度最大100】

userNames

string

可选

账号名称【支持关键词长度最大100】

authors

string

可选

作者【支持关键词长度最大100】

userIds

string

可选

账号ID【支持关键词长度最大100】

channelNames

string

可选

站点渠道名称【支持关键词长度最大100】

customId

string

可选

个性化账号id【支持关键词长度最大100】

secUid

string

可选

用户第二uid【支持关键词长度最大100】,账号检索可用，发文检索不可用

host

string

可选

域名【支持关键词长度最大100】

sortInfo

object (BaseSort)

排序信息

可选

sortField

integer <int32>

可选

排序类型【默认发布时间排序,1-发布时间、2-阅读量、3-转发量、4-评论量、5-点赞量、6-播放量、7-热度、8-在看量、9-采集时间、10-相关度排序、11-Gid排序、12-综合排序、13-入ES时间、14-累加互动量、15-收藏量、16-弹幕量、17-投币量、18-加权互动量、19-表情_总表情数、20-10W+热文】

>= -1<= 20

示例值:

sortWay

string

可选

排序方式【默认倒序,asc-正序、desc-倒序】

示例值:

desc

secondSearch

object (SecondSearch)

二次搜索对象

可选

value

string

可选

二次检索值【空格支持多组搜索】

matchMethod

integer <int32>

可选

匹配字段【默认正文匹配, 2-OCR、3-语音、5-全文(标题+正文+OCR+语音)、6-标题、7-正文(内容)、8-发布平台(站点名称暂不支持模糊匹配)、9-作者、10-频道名称】

示例值:

queryType

boolean

可选

查询方式,默认精确查找、true-精确、false-模糊

size

integer <int32>

可选

返回条数【默认500，最大支持2000】

>= 500<= 2000

示例值:

500

time

integer <int32>

可选

ScrollId过期时间【默认5, 单位：分钟, 最大支持30分钟】

>= 1<= 30

示例值:

includeFields

array[string]

查询包含字段

可选

示例

{
  "articleInfo": {
    "searchMode": {
      "searchType": 0,
      "keywordExps": [
        "string"
      ],
      "simpleKeyword": {
        "mustKeyWord": [
          "string"
        ],
        "mustKeyWordComplex": [
          "string"
        ],
        "anyKeyWord": [
          "string"
        ],
        "needExclude": [
          "string"
        ]
      },
      "queryType": true
    },
    "searchTime": {
      "realTime": 1,
      "now": "yyyy-MM-dd HH:mm:ss",
      "startPubTime": "yyyy-MM-dd HH:mm:ss",
      "endPubTime": "yyyy-MM-dd HH:mm:ss"
    },
    "dataSources": [
      "string"
    ],
    "matchMethods": [
      0
    ],
    "articleTypes": [
      0
    ],
    "ipAreaCountry": [
      "string"
    ],
    "ipAreaProvinces": [
      "string"
    ],
    "urls": [
      "string"
    ],
    "insertTime": {
      "startInsertTime": "yyyy-MM-dd HH:mm:ss",
      "endInsertTime": "yyyy-MM-dd HH:mm:ss"
    },
    "esInsertTime": {
      "startEsInsertTime": "yyyy-MM-dd HH:mm:ss",
      "endEsInsertTime": "yyyy-MM-dd HH:mm:ss"
    },
    "signInAreas": [
      {
        "signInCountry": "string",
        "signInProvince": "string",
        "signInCity": "string",
        "signInCounty": "string"
      }
    ],
    "isPaid": -1,
    "isAdvertisement": -1,
    "author": [
      "string"
    ],
    "topicTags": [
      "string"
    ],
    "mediaTypes": [
      0
    ],
    "mediaTypeMatch": 0,
    "rootArticleIds": [
      "string"
    ]
  },
  "articlePlatform": {
    "mediaInfos": [
      {
        "include": true,
        "dataSource": "string",
        "websiteName": "string",
        "host": "string",
        "subHost": "string",
        "channelName": "string",
        "mediaType": "string",
        "hostType": "string",
        "userId": "string",
        "userName": "string"
      }
    ],
    "isForeignMedia": -1,
    "country": [
      "string"
    ],
    "mediaAreas": [
      {
        "mediaAreaProvince": "string",
        "mediaAreaCity": "string",
        "mediaAreaCounty": "string"
      }
    ],
    "mediaTags": [
      "string"
    ],
    "excludeMediaTags": [
      "string"
    ]
  },
  "articleUser": {
    "userIds": [
      "string"
    ],
    "customIds": [
      "string"
    ],
    "userNames": [
      "string"
    ],
    "userSex": "string",
    "isVerified": -1,
    "verifiedTypes": [
      0
    ],
    "fanRange": {
      "fromFan": 0,
      "toFan": 0
    },
    "userRegisterAreas": [
      {
        "userCountry": "string",
        "userProvince": "string",
        "userCity": "string",
        "userCounty": "string"
      }
    ]
  },
  "articleAnalysis": {
    "languages": [
      "string"
    ],
    "categories": [
      "string"
    ],
    "polarities": [
      0
    ],
    "isSensitive": 0,
    "subjectSentiments": [
      "string"
    ],
    "contentAreas": [
      {
        "contentAreaCountry": "string",
        "contentAreaProvince": "string",
        "contentAreaCity": "string",
        "contentAreaCounty": "string"
      }
    ],
    "mediaGradeTags": [
      {
        "tags1": [
          "string"
        ],
        "tags2": [
          "string"
        ],
        "tags3": [
          "string"
        ],
        "tags4": [
          "string"
        ],
        "tags5": [
          "string"
        ],
        "tags6": [
          "string"
        ],
        "tags7": [
          "string"
        ]
      }
    ],
    "fingerprint": "string",
    "isFingerprintHead": 0,
    "subjectExtract": [
      "string"
    ],
    "contentClassify": [
      "string"
    ]
  },
  "areaType": "1",
  "hiddenMark": {
    "hideMark": "string",
    "isHidden": true
  },
  "accountMatchDTO": {
    "matchType": 0,
    "defaultOperator": 1,
    "websiteNames": "string",
    "subWebsiteNames": "string",
    "userNames": "string",
    "authors": "string",
    "userIds": "string",
    "channelNames": "string",
    "customId": "string",
    "secUid": "string",
    "host": "string"
  },
  "sortInfo": {
    "sortField": 1,
    "sortWay": "desc"
  },
  "secondSearch": {
    "value": "string",
    "matchMethod": 7,
    "queryType": true
  },
  "size": 500,
  "time": 5,
  "includeFields": [
    "string"
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/v1/search/getScrollListByParam' \
--header 'appKey;' \
--header 'nonce;' \
--header 'timestamp;' \
--header 'signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "articleInfo": {
        "searchMode": {
            "searchType": 0,
            "keywordExps": [
                "string"
            ],
            "simpleKeyword": {
                "mustKeyWord": [
                    "string"
                ],
                "mustKeyWordComplex": [
                    "string"
                ],
                "anyKeyWord": [
                    "string"
                ],
                "needExclude": [
                    "string"
                ]
            },
            "queryType": true
        },
        "searchTime": {
            "realTime": 1,
            "now": "yyyy-MM-dd HH:mm:ss",
            "startPubTime": "yyyy-MM-dd HH:mm:ss",
            "endPubTime": "yyyy-MM-dd HH:mm:ss"
        },
        "dataSources": [
            "string"
        ],
        "matchMethods": [
            0
        ],
        "articleTypes": [
            0
        ],
        "ipAreaCountry": [
            "string"
        ],
        "ipAreaProvinces": [
            "string"
        ],
        "urls": [
            "string"
        ],
        "insertTime": {
            "startInsertTime": "yyyy-MM-dd HH:mm:ss",
            "endInsertTime": "yyyy-MM-dd HH:mm:ss"
        },
        "esInsertTime": {
            "startEsInsertTime": "yyyy-MM-dd HH:mm:ss",
            "endEsInsertTime": "yyyy-MM-dd HH:mm:ss"
        },
        "signInAreas": [
            {
                "signInCountry": "string",
                "signInProvince": "string",
                "signInCity": "string",
                "signInCounty": "string"
            }
        ],
        "isPaid": -1,
        "isAdvertisement": -1,
        "author": [
            "string"
        ],
        "topicTags": [
            "string"
        ],
        "mediaTypes": [
            0
        ],
        "mediaTypeMatch": 0,
        "rootArticleIds": [
            "string"
        ]
    },
    "articlePlatform": {
        "mediaInfos": [
            {
                "include": true,
                "dataSource": "string",
                "websiteName": "string",
                "host": "string",
                "subHost": "string",
                "channelName": "string",
                "mediaType": "string",
                "hostType": "string",
                "userId": "string",
                "userName": "string"
            }
        ],
        "isForeignMedia": -1,
        "country": [
            "string"
        ],
        "mediaAreas": [
            {
                "mediaAreaProvince": "string",
                "mediaAreaCity": "string",
                "mediaAreaCounty": "string"
            }
        ],
        "mediaTags": [
            "string"
        ],
        "excludeMediaTags": [
            "string"
        ]
    },
    "articleUser": {
        "userIds": [
            "string"
        ],
        "customIds": [
            "string"
        ],
        "userNames": [
            "string"
        ],
        "userSex": "string",
        "isVerified": -1,
        "verifiedTypes": [
            0
        ],
        "fanRange": {
            "fromFan": 0,
            "toFan": 0
        },
        "userRegisterAreas": [
            {
                "userCountry": "string",
                "userProvince": "string",
                "userCity": "string",
                "userCounty": "string"
            }
        ]
    },
    "articleAnalysis": {
        "languages": [
            "string"
        ],
        "categories": [
            "string"
        ],
        "polarities": [
            0
        ],
        "isSensitive": 0,
        "subjectSentiments": [
            "string"
        ],
        "contentAreas": [
            {
                "contentAreaCountry": "string",
                "contentAreaProvince": "string",
                "contentAreaCity": "string",
                "contentAreaCounty": "string"
            }
        ],
        "mediaGradeTags": [
            {
                "tags1": [
                    "string"
                ],
                "tags2": [
                    "string"
                ],
                "tags3": [
                    "string"
                ],
                "tags4": [
                    "string"
                ],
                "tags5": [
                    "string"
                ],
                "tags6": [
                    "string"
                ],
                "tags7": [
                    "string"
                ]
            }
        ],
        "fingerprint": "string",
        "isFingerprintHead": 0,
        "subjectExtract": [
            "string"
        ],
        "contentClassify": [
            "string"
        ]
    },
    "areaType": "1",
    "hiddenMark": {
        "hideMark": "string",
        "isHidden": true
    },
    "accountMatchDTO": {
        "matchType": 0,
        "defaultOperator": 1,
        "websiteNames": "string",
        "subWebsiteNames": "string",
        "userNames": "string",
        "authors": "string",
        "userIds": "string",
        "channelNames": "string",
        "customId": "string",
        "secUid": "string",
        "host": "string"
    },
    "sortInfo": {
        "sortField": 1,
        "sortWay": "desc"
    },
    "secondSearch": {
        "value": "string",
        "matchMethod": 7,
        "queryType": true
    },
    "size": 500,
    "time": 5,
    "includeFields": [
        "string"
    ]
}'

返回响应

🟢200OK

application/json

Body

返回数据格式

code

integer <int32>

可选

响应码【200代表成功,其他参见错误码值表】)

success

boolean

可选

是否成功【true代表成功,false代表失败】

message

string

响应消息

可选

data

object (ScrollSearchResultVO)

响应数据

可选

list

array[object (SearchResultVO) {50}]

可选

scrollId

string

可选

errors

array[string]

错误信息集合

可选

time

string <date-time>

响应时间

可选

示例

{
  "code": 0,
  "success": true,
  "message": "string",
  "data": {
    "list": [
      {
        "gid": 0,
        "uuid": "string",
        "title": "string",
        "layoutName": "string",
        "layoutCode": "string",
        "paperPicture": [
          "string"
        ],
        "author": "string",
        "source": "string",
        "abstract1": "string",
        "content": "string",
        "imageOcrContent": "string",
        "imageOcrVo": "string",
        "audioContent": "string",
        "publishTime": "string",
        "crawlerTime": "string",
        "updateTime": "string",
        "esInsertTime": "string",
        "url": "string",
        "picturesArray": [
          "string"
        ],
        "videosArray": [
          "string"
        ],
        "videosCoverArray": [
          "string"
        ],
        "mediaType": [
          0
        ],
        "htmlInfo": "string",
        "likeCount": 0,
        "commentCount": 0,
        "readCount": 0,
        "playCount": 0,
        "watchCount": 0,
        "rttCount": 0,
        "collectCount": 0,
        "barrageCount": 0,
        "coinCount": 0,
        "topicTags": [
          "string"
        ],
        "articleType": 0,
        "rootArticle": {
          "rootIndex": "string",
          "rootArticleId": "string",
          "rootArticleUrl": "string"
        },
        "rootArticleId": "string",
        "parentArticleId": "string",
        "ipAreaName": "string",
        "ipAreaCountry": "string",
        "ipAreaProvince": "string",
        "platform": {
          "dataSourceType": "string",
          "websiteName": "string",
          "host": "string",
          "subHost": "string",
          "country": "string",
          "isForeignMedia": 0,
          "mediaAreaProvince": "string",
          "mediaAreaCity": "string",
          "mediaAreaCounty": "string",
          "channelName": "string",
          "channelUrl": "string",
          "mediaTags": [
            "string"
          ]
        },
        "user": {
          "userId": "string",
          "secUid": "string",
          "customId": "string",
          "userName": "string",
          "url": "string",
          "headImageUrl": "string",
          "isVerified": 0,
          "verifiedType": 0,
          "followersCount": 0,
          "publishCount": 0
        },
        "analysis": {
          "fingerprint": "string",
          "isFingerprintHead": 0,
          "interactionCount": 0,
          "weightInteractionCount": 0,
          "entityAddress": [
            "string"
          ],
          "entityOrganization": [
            "string"
          ],
          "entityPeople": [
            "string"
          ],
          "analyzeLocation": [
            "string"
          ],
          "keywords": [
            "string"
          ],
          "language": "string",
          "polarity": 0,
          "subjectSentiment": [
            "string"
          ],
          "isSensitive": 0,
          "sensitiveWords": [
            "string"
          ],
          "contentAreaCountry": [
            "string"
          ],
          "contentAreaProvince": [
            "string"
          ],
          "contentAreaCity": [
            "string"
          ],
          "contentAreaCounty": [
            "string"
          ],
          "category": "string",
          "firstPublication": 0,
          "expertOpinions": [
            "string"
          ],
          "keyPhrase": [
            "string"
          ],
          "phrases": [
            "string"
          ],
          "subjectExtract": [
            "string"
          ],
          "heatNumber": 0,
          "rank": 0,
          "tags1": [
            "string"
          ],
          "tags2": [
            "string"
          ],
          "tags3": [
            "string"
          ],
          "tags4": [
            "string"
          ],
          "tags5": [
            "string"
          ],
          "tags6": [
            "string"
          ],
          "tags7": [
            "string"
          ]
        },
        "articleId": "string",
        "isPaid": 0,
        "allFaceCount": 0,
        "isAdvertisement": 0,
        "hectare": "string",
        "firstPicture": "string",
        "articlePage": "string"
      }
    ],
    "scrollId": "string"
  },
  "errors": [
    "string"
  ],
  "time": "2019-08-24T14:15:22Z"
}