文档首页> 云消息服务 KooMessage> API参考> API> 智能信息服务号资料> 查询服务号列表
更新时间：2023-08-21 GMT+08:00
查看PDF
分享

查询服务号列表

功能介绍

支持根据用户提供的过滤条件查询服务号列表。

URI

GET /v1/aim-sa/pubs

表1 Query参数

参数

是否必选

参数类型

描述

pub_name

否

String

服务号名称。

最小长度：1

最大长度：15

state

否

Integer

服务号状态。

  • 1：未生效

  • 2：已生效

  • 3：已失效

  • 4：已冻结

最小值：1

最大值：4

start_time

否

String

开始上线时间，格式为：yyyy-MM-ddTHH:mm:ssZ。

offset

否

Integer

偏移量，表示从此偏移量开始查询，offset大于等于0。

最小值：0

最大值：214748364

缺省值：0

limit

否

Integer

每页显示的条目数量。

最小值：1

最大值：100

缺省值：10

end_time

否

String

结束上线时间，格式为：yyyy-MM-ddTHH:mm:ssZ。

industry

否

String

服务号所属行业。

  • 1：金融理财

  • 2：社交通讯

  • 3：影音娱乐

  • 4：旅游出行

  • 5：购物

  • 6：本地生活

  • 7：运动健康

  • 8：教育培训

  • 9：新闻阅读

  • 10：运营商

  • 11：其他

最小值：1

最大值：11

approve_state

否

Integer

审核状态。

  • 1：审核中

  • 2：审核通过

  • 3：驳回

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

data

SearchPubDetail object

查询服务号列表响应体。
表4 SearchPubDetail

参数

参数类型

描述

page_info

PageOffSet object

包含当前查询分页信息和可查询数据总数。

data

Array of PubDetail objects

服务号详情。

数组长度：0 - 2147483647
表5 PageOffSet

参数

参数类型

描述

offset

Integer

偏移量，表示从此偏移量开始查询，offset大于等于0。

limit

Integer

每页显示的条目数量。

total

Integer

总量。
表6 PubDetail

参数

参数类型

描述

pub_id

String

服务号ID。

oper_time

String

最新操作时间，格式：yyyy-MM-ddTHH:mm:ssZ。

state

Integer

服务号状态。

  • 1：未生效

  • 2：已生效

  • 3：已失效

  • 4：已冻结

online_time

String

上线时间，格式为：yyyy-MM-ddTHH:mm:ssZ。

company_name

String

企业名称。

pub_name

String

服务号名称。

logo_img

String

服务号LOGO图片资源ID。

logo_url

String

服务号LOGO图片URL。

authorization_files

Map<String,String>

授权证明图片的OBSURL地址。

数组长度：0 - 6

auto_get_port

Integer

是否授权系统自动收集端口。

  • 0：否

  • 1：是

缺省值：0

industry

Integer

从事行业，默认取服务号所属商家的行业分类。

  • 1：金融理财

  • 2：社交通讯

  • 3：影音娱乐

  • 4：旅游出行

  • 5：购物

  • 6：本地生活

  • 7：运动健康

  • 8：教育培训

  • 9：新闻阅读

  • 10：运营商

  • 11：其他

pub_abstract

String

服务号简介。

signs_for_auto_get_port

Array of strings

自动收集端口使用的签名列表。

说明：

auto_get_port为1时，该字段为必填，每个签名长度为2-18个字符，每个服务号签名不可以重复。

数组长度：0 - 5

company_id

String

企业ID。

pub_remark

String

服务号备注。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

结果详情。

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

结果详情。

请求示例

查询服务号列表

https://koomessage.myhuaweicloud.cn/v1/aim-sa/pubs

响应示例

状态码： 200

返回信息。

{
  "page_info" : {
    "offset" : 0,
    "limit" : 1,
    "total" : 143
  },
  "data" : [ {
    "pub_id" : "9405df1846a348e0b997d855bf80acc7",
    "company_id" : "6b3dd34b00e94326908720fa97f2b132",
    "pub_remark" : "K歌",
    "oper_time" : "2022-06-01T15:03:36Z",
    "state" : 1,
    "online_time" : "2022-06-07T14:08:09Z",
    "company_name" : null,
    "pub_name" : "轰趴馆-K歌",
    "logo_img" : "ab44b435b7a442a59e199735a9e3ce26",
    "logo_url" : "AimSauploadService/1dc408cff6b147a690f19732a42731273.png",
    "authorization_files" : {
      "63e2a3d465744bf69cf0321bd3e9bfb2" : "AimSauploadService/75356fb37c5b4067ba691ea2026ec69e3.png"
    },
    "auto_get_port" : 1,
    "industry" : 1,
    "pub_abstract" : "我来一首天籁吧",
    "signs_for_auto_get_port" : null
  } ]
}

状态码

状态码

描述

200

返回信息。

400

非法参数。

500

内部错误。

错误码

请参见错误码。

分享：

    相关文档

    相关产品