全量获取设备成员列表

POST

https://qyapi.weixin.qq.com/cgi-bin/openhw/device/get_userinfo_by_page

获取设备可用范围内的成员列表。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://qyapi.weixin.qq.com/cgi-bin/openhw/device/get_userinfo_by_page' \
--header 'Content-Type: application/json' \
--data-raw '{
	"cursor":"CURSOR",
	"limit":100,
	"only_perm_version":false
}'

响应示例

{
  "errcode": 0,
  "errmsg": "ok",
  "next_cursor": "xxxx",
  "perm_version": 5,
  "userinfo": {
    "useritems": [
      {
        "open_userid": "ww***********",
        "user_name": "张三",
        "user_type": 1,
        "pass_rule": {
          "rule_list": [
            {
              "id": 0,
              "rule": "9:00-10:00 * * 1-5 *",
              "effect_time": 1542874137
            },
            {
              "id": 1,
              "rule": "9:30-10:00 * * 6 *",
              "effect_time": 1542874137
            }
          ]
        }
      }
    ]
  }
}

请求参数

Query 参数

device_access_token

string

可选

device_access_token ,获取方式见获取设备型号调用凭证

示例值:

DEVICE_ACCESS_TOKEN

Body 参数application/json

cursor

string

可选

上一次调用时返回的next_cursor，初次调用可以不填

limit

integer

可选

返回的最大记录数，整型，最大值200，默认值100

only_perm_version

boolean

可选

是否仅获取perm_version，若为true，会忽略输入的其他参数

示例

返回响应

🟢200成功

application/json

Body

errcode

integer

错误码

必需

errmsg

string

错误码描述

必需

next_cursor

string

必需

当前数据最后一个key值，如果下次调用带上该值则从该key值往后拉，用于实现分页拉取，返回空字符串代表已经是最后一页

perm_version

integer

必需

当前云端通讯录版本号

userinfo

object

必需

useritems

array [object {4}]

必需

修改于 2022-12-08 06:24:19