查询已创建的线索组件

我的收藏

在创建线索组件之后，开发者可通过此 openApi 查询已创建的线索组件，查询效果与官网对应页面中展示的线索组件列表一致。

使用限制

•

无

接口说明

基本信息

名称	描述
HTTP URL	https://developer.toutiao.com/api/apps/v1/capacity/query_clue_component_info
HTTP Method	GET
Scope	无
权限要求	服务商代调用场景下，需商家授予运营管理权限集

请求头

名称	类型	必填	描述
access-token	string	是	token获取接口（其中服务商代调用场景的token获取接口）

query

名称	类型	是否必填	描述
page_no	int32	否	分页游标，默认从1开始
page_size	int32	否	分页大小，取值范围[1,20]，默认值20

请求示例

https://developer.toutiao.com/api/apps/v1/capacity/query_clue_component_info?page_no=1&page_size=20

响应参数

名称				类型	是否必填	描述	默认值
err_no				number	是	错误码
err_msg				string	是	错误信息
log_id				string	是	log_id，用于向内部开发人员进行反馈
data				object	是	响应结果	{}
	clue_component_list			array<object>	否	线索组件列表
		config_id		string	是	线索组件id（线索组件的唯一标识）
		config_name		string	是	线索组件的名称
		region		string	是	创建线索组件时所填入的地区编码
		category_id		string	是	创建线索组件时所填入的类目id
		state		string	是	当前线索组件的状态（0-未激活 1-已激活 2-已失效）
		category_name		string	是	类目id所对应的中文类目
		region_name		string	是	地区编码对应的中文位置
		region_list		Array<object>	否	地区列表
			region	string	是	当前填写的编码
			province_code	string	是	省份编码
			province_name	string	是	省份名称
			city_code	string	是	城市编码
			city_name	string	是	城市名称
			district_code	string	是	地区编码
			district_name	string	是	地区名称
	cert_status			bool	是	当前app_id是否有创建线索组件的权限，未开通线索组件能力返回false
	total			int64	是	线索组件总数

响应示例

正常示例

"err_no": 0,
"err_msg": "success",
"log_id":"xxx",
"data":{
  "clue_component_list":[
    // 线索组件1
    {
      "config_id":"xxx", //线索组件id
      "config_name":"xxx", //线索组件名
      "region":"xxx", //地区编号
      "category_id":"xxx", //服务类目id
      "state":"xxx", //激活状态
      "region_name":"xxx", //地区编号对应的中文名
      "category_name":"xxx" //类目id对应的中文名
    },
    // 线索组件2
    {
      "config_id":"xxx", //线索组件id
      "config_name":"xxx", //线索组件名
      "region":"xxx", //地区编号
      "category_id":"xxx", //服务类目id
      "state":"xxx", //激活状态
      "region_name":"xxx", //地区编号对应的中文名
      "category_name":"xxx" //类目id对应的中文名
    }
  ],
  "cert_status":false, //非定向邀约小程序或小程序类目不合要求，返回false
  "total":32
}

异常示例

{
    "err_no": -1,
    "err_msg": "系统错误",
    "log_id": "xxxx",
    "data": {
    }
}

错误码

HTTP 状态码	错误码	描述	排查建议
200	11009	参数不合法或缺少参数	检查body中的字段名及对应值类型是否正确
200	11016	access_token不正确或已过期	重新生成access_token或刷新access_token
200	11001	app_id无法解析	重试，若重试不行则重新生成access_token，还不行可使用log_id向内部开发同学反馈
200	40036	授权小程序未授予对应的接口权限	重新授予相关权限后，刷新access_token重试
200	-1	系统错误	重试，多次重试失败可使用log_id向内部同学反馈
200	30002	参数不合法，请确认地区编号，线索组件名称，线索组件id等是否满足基本要求	请确认地区编号是否与国家公示网上的保持一致以及是否精确到了区/县；请检查配置名称的长度是否超过了20个字；请检查传入的线索组件id是否正确