跳到主要内容

查询邮件组列表

GET/v2/groups

查询当前组织下的邮件组，单次最多返回 30 条数据。

过滤条件​

使用 filter 表达式过滤邮件组，支持的字段为 email、name、status、domain 和 type。例如：

  • (name=*Engineering*)：名称中包含“Engineering”。
  • (|(name=Jack)(email=*jack*))：名称为“Jack”，或邮箱地址中包含 jack。
  • (&(type=DYNAMIC)(status=FREEZE))：类型为动态组且状态为已冻结。
  • (domain=example.com)：属于子域名 example.com。

排序​

支持按 email、name 或 createdTime 排序。

Request​

Query parameters

    filter string

    过滤表达式

    cursor string
    size number

    分页大小，最大 100

    types array

    指定类型，不指定则返回所有类型的组后续版本将废弃，可使用 filter 指定类型

    orderby string

    排序字段，不填则按 创建时间 倒排

    order enum

    Possible values: [ASC, DES]

    • ASC:
    • DES:
    $select string

响应

    groups object[]
    id string

    id

    name stringrequired

    组名

    email stringrequired

    组邮件地址

    status enum

    状态，仅管理员或授权应用可修改

    • NORMAL: 正常
    • FREEZE: 冻结

    Possible values: [NORMAL, FREEZE]

    createdTime number<int64>

    创建时间

    itemCount number<int32>

    一级静态成员数

    admins string[]

    管理员，仅管理员或授权应用可修改（可选字段：在URL中增加$select=admins查询参数后返回，如需多个字段使用英文逗号分隔）

    needMessageDeliveryReview boolean

    是否需要消息投递审核，仅管理员或授权应用可访问，可修改（可选字段：在URL中增加$select=needMessageDeliveryReview查询参数后返回，如需多个字段使用英文逗号分隔）

    messageDeliveryReviewers string[]

    消息投递审核员，仅管理员或授权应用可访问，可修改（可选字段：在URL中增加$select=messageDeliveryReviewers查询参数后返回，如需多个字段使用英文逗号分隔）

    allowedSenders string[]

    可发消息给该组的人员，仅管理员或授权应用可访问，可修改（可选字段：在URL中增加$select=allowedSenders查询参数后返回，如需多个字段使用英文逗号分隔）

    allowedSenderPolicy enum

    允许哪些人发消息给该组，仅管理员或授权应用可访问，可修改（可选字段：在URL中增加$select=allowedSenderPolicy查询参数后返回，如需多个字段使用英文逗号分隔）

    • ANYONE:
    • SAME_ORGANIZATION:
    • GROUP_MEMBER:
    • ONLY_ALLOWED_SENDER:
    • GROUP_MEMBER_AND_ALLOWED_SENDER:

    Possible values: [ANYONE, SAME_ORGANIZATION, GROUP_MEMBER, ONLY_ALLOWED_SENDER, GROUP_MEMBER_AND_ALLOWED_SENDER]

    type enum

    组类型，仅管理员或授权应用可访问（可选字段：在URL中增加$select=type查询参数后返回，如需多个字段使用英文逗号分隔）

    • STATIC: 静态组
    • DEPARTMENT: 部门组
    • DYNAMIC: 动态组
    • USERGROUP: 群组
    • DING: 钉钉组

    Possible values: [STATIC, DEPARTMENT, DYNAMIC, USERGROUP, DING]

    dynamicMatchRule string

    动态组成员匹配规则，仅管理员或授权应用可访问，可修改（可选字段：在URL中增加$select=dynamicMatchRule查询参数后返回，如需多个字段使用英文逗号分隔）

    itemCountLimit number<int32>

    最大成员数限制，不超过100000，仅管理员或授权应用可修改（可选字段：在URL中增加$select=itemCountLimit查询参数后返回，如需多个字段使用英文逗号分隔）

    containOuterMember boolean

    是否包含外部成员（可选字段：在URL中增加$select=containOuterMember查询参数后返回，如需多个字段使用英文逗号分隔）

    departmentId string

    归属部门（可选字段：在URL中增加$select=departmentId查询参数后返回，如需多个字段使用英文逗号分隔）

    isHidden boolean

    是否在通讯录显示此组，仅管理员或授权应用可访问，可修改（可选字段：在URL中增加$select=isHidden查询参数后返回，如需多个字段使用英文逗号分隔）

    creator string

    创建者 email，仅管理员或授权应用可访问（可选字段：在URL中增加$select=creator查询参数后返回，如需多个字段使用英文逗号分隔）

    lastRecvMessageTime string<date-time>

    最后一次收到消息的时间（可选字段：在URL中增加$select=lastRecvMessageTime查询参数后返回，如需多个字段使用英文逗号分隔）

    ignoreAutoReplyOfMember boolean

    忽略成员的自动回复，仅管理员或授权应用可访问，可修改（可选字段：在URL中增加$select=ignoreAutoReplyOfMember查询参数后返回，如需多个字段使用英文逗号分隔）

    sendMessageToNewMember boolean

    是否发送通知信给新加入的成员，仅管理员或授权应用可访问，可修改（可选字段：在URL中增加$select=sendMessageToNewMember查询参数后返回，如需多个字段使用英文逗号分隔）

    requireApprovalWhenMemberLeaves boolean

    成员退出是否需要管理员审核，仅管理员或授权应用可访问，可修改（可选字段：在URL中增加$select=requireApprovalWhenMemberLeaves查询参数后返回，如需多个字段使用英文逗号分隔）

    memberOnlyVisibleToAdmin boolean

    成员是否仅管理员可见，仅管理员或授权应用可修改（可选字段：在URL中增加$select=memberOnlyVisibleToAdmin查询参数后返回，如需多个字段使用英文逗号分隔）

    nextCursor string
    hasMore boolean

错误

401

访问未授权，请检查是否传递了正确的授权token

403

无API访问权限，请在域管的应用管理页面完成相关授权