查询服务组列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

POST /services/group/list HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
Object Body

A short description of struct

queryName String Body 王宇

搜索名称

queryType String Body USER

搜索类型 USER用户 SERVICEGROUP服务组

pageNumber Long Body 1

当前页

pageSize Long Body 10

页大小

clientToken String Body C4BE3837-1A13-413B-A225-2C88188E8A43

幂等号

isScheduled Boolean Body false

是否排过班

orderByScheduleStatus Boolean Body false

订单状态

userId Long Body 100000

用户ID

返回数据

名称 类型 示例值 描述
requestId String sssss

Id of the request

data Array of 服务组列表

服务组列表

serviceGroupId Long 1

服务组ID

isScheduled Boolean true

是否已经排班

serviceGroupName String 我的服务组

服务组名字

serviceGroupDescription String 服务组描述

服务组描述

updateTime String 2020-08-09 15:50:30

修改时间

enableWebhook String ENABLE

ENABLE 启用 DISABLE 禁用

webhookType String WEIXIN_GROUP

WEIXIN_GROUP 微信 DING_GROUP 钉钉

webhookLink String wwwwwwwwww

webhook 跳转地址

users Array of 服务组用户列表

服务组用户列表

userId Long 10

用户ID

userName String jack

用户名字

serviceGroupId Long 1

服务组ID

phone String 1390000****

手机号

email String wy930***@163.com

邮箱

isRelated Integer 1

用户是否关联了移动APP1:是,0:否

pageNumber Long 1

当前页

pageSize Long 10

分页大小

totalCount Long 100

总条数

示例

请求示例

POST /services/group/list HTTP/1.1
Host:gemp.aliyuncs.com
Content-Type:application/json

{
  "queryName" : "王宇",
  "queryType" : "USER",
  "pageNumber" : 1,
  "pageSize" : 10,
  "clientToken" : "C4BE3837-1A13-413B-A225-2C88188E8A43",
  "isScheduled" : false,
  "userId" : 100000
}

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListServiceGroupsResponse>
    <requestId>sssss</requestId>
    <data>
        <serviceGroupId>1</serviceGroupId>
        <isScheduled>true</isScheduled>
        <serviceGroupName>我的服务组</serviceGroupName>
        <serviceGroupDescription>服务组描述</serviceGroupDescription>
        <updateTime>2020-08-09 15:50:30</updateTime>
        <enableWebhook>ENABLE</enableWebhook>
        <webhookType>WEIXIN_GROUP</webhookType>
        <webhookLink>wwwwwwwwww</webhookLink>
        <users>
            <userId>10</userId>
            <userName>jack</userName>
            <serviceGroupId>1</serviceGroupId>
            <phone>1390000****</phone>
            <email>wy930***@163.com</email>
        </users>
    </data>
    <pageNumber>1</pageNumber>
    <pageSize>10</pageSize>
    <totalCount>100</totalCount>
</ListServiceGroupsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "requestId" : "sssss",
  "data" : [ {
    "serviceGroupId" : 1,
    "isScheduled" : true,
    "serviceGroupName" : "我的服务组",
    "serviceGroupDescription" : "服务组描述",
    "updateTime" : "2020-08-09 15:50:30",
    "enableWebhook" : "ENABLE",
    "webhookType" : "WEIXIN_GROUP",
    "webhookLink" : "wwwwwwwwww",
    "users" : [ {
      "userId" : 10,
      "userName" : "jack",
      "serviceGroupId" : 1,
      "phone" : "1390000****",
      "email" : "wy930***@163.com"
    } ]
  } ],
  "pageNumber" : 1,
  "pageSize" : 10,
  "totalCount" : 100
}

错误码

访问错误中心查看更多错误码。

访问错误中心查看更多错误码。