获取渠道活码列表

请求参数

Header 参数

appId

string

应用 appId

必需

默认值:

timestamp

string

请求时间戳

必需

默认值:

sign

string

请求消息签名值

必需

默认值:

appKey

string

应用 appKey

可选

默认值:

Body 参数application/json

state

string

活码名称

可选

精确匹配

userIds

array[number]

适用员工

可选

长度限制50

deptIds

array[number]

适用部门

可选

长度限制20

groupIds

array[number]

活码分组ID

可选

returnChildren为0时：长度限制50；
returnChildren为1时：长度限制1。

returnChildren

integer

是否查询子分组

可选

returnChildren不传默认为0。
returnChildren=0：查询指定[groupIds]分组的渠道活码数据（不包含当前分组下的子分组数据）。
returnChildren=1：查询指定[groupIds]分组的渠道活码数据（包含当前分组和当前分组下所有子分组数据）。

startTime

string

创建开始时间

可选

时间格式：yyyy-MM-dd HH:mm:ss时间范围：[startTime，endTime)最大30天

endTime

string

创建结束时间

可选

时间格式：yyyy-MM-dd HH:mm:ss时间范围：[startTime，endTime)最大30天

nextId

number

可选

返回结果中的nextId，用于拉取下一页数据

size

number

页条数

可选

范围10-100，默认10

示例

{
    "userIds": [
        91
    ],
    "deptIds": [
        91
    ],
    "groupIds": [
        59,
        74,
        42
    ],
    "startTime": "1997-07-16 13:19:53",
    "endTime": "1977-10-27 16:56:14",
    "size": 73,
    "nextId": 25
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/v3/channelcode/list' \
--header 'appId;' \
--header 'timestamp;' \
--header 'sign;' \
--header 'appKey: {{appKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userIds": [
        91
    ],
    "deptIds": [
        91
    ],
    "groupIds": [
        59,
        74,
        42
    ],
    "startTime": "1997-07-16 13:19:53",
    "endTime": "1977-10-27 16:56:14",
    "size": 73,
    "nextId": 25
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

data

object

必需

channelcodes

array [object {11}]

必需

nextId

number

游标

必需

用于下次分页查询，返回-1表示查询到最后一页

示例

{
    "code": 0,
    "message": "success",
    "data": {
        "channelcodes": [
            {
                "id": 27004,
                "state": "分组_1_1_活码02",
                "description": "分组_1_1_活码02",
                "codeUrl": "https://wework.qpic.cn/wwpic/396673_0NHJxrUuSdyOitZ_1677663434/0",
                "createTime": "2023-03-01 17:37:12",
                "groupId": 527448137486400,
                "groupName": "分组_1_1",
                "creatorId": 389394161352768,
                "users": [
                    1234,
                    34535
                ],
                "backendUsers": [
                    1234,
                    34535
                ]
            },
            {
                "id": 27003,
                "state": "分组_1_1_活码01",
                "description": "分组_1_1_活码01",
                "codeUrl": "https://wework.qpic.cn/wwpic/726845_s-31mQCTQC2eWEx_1677585610/0",
                "createTime": "2023-03-01 17:37:12",
                "groupId": 527448137486400,
                "groupName": "分组_1_1",
                "creatorId": 389394161352768,
                "users": [
                    389394161352768,
                    34535
                ],
                "backendUsers": [
                    1234,
                    389394161352768
                ]
            }
        ],
        "nextId": 27003
    }
}