搜索邮件组

在当前企业范围内搜索邮件组

请求说明

请求地址	https://openapi.wps.cn/v7/mail_groups/search
请求方法	GET
签名方式	KSO-1
权限要求	查询和管理邮件组信息（用户授权） kso.mail_group.readwrite 查询邮件组信息（用户授权） kso.mail_group.read

请求头（Header）

Header 名称	参数类型	是否必填	说明
Content-Type	string	是	使用：application/json
X-Kso-Date	string	是	RFC1123 格式的日期，例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-Authorization	string	是	KSO-1 签名值，详见《签名方法》
Authorization	string	是	授权凭证，格式为：Bearer {access_token}

查询参数（Query）

名称	参数类型	是否必填	说明
owner_address	string	否	搜索条件，邮件组负责人地址，精确搜索
page_size	integer	是	分页大小
page_token	string	否	翻页 token，获取首页无需提供
with_total	boolean	否	是否返回 total 字段，默认不返回

请求地址示例

[GET] https://openapi.wps.cn/v7/mail_groups/search?owner_address={string}&page_size={integer}&page_token={string}&with_total={boolean}

响应体

名称	参数类型	说明
code	integer	响应代码。非 0 表示失败，参照《状态码说明》
msg	string	响应信息
data	object	响应数据
∟ items	array[object]	邮件组列表
∟ ∟ accepted_senders	array[object]	允许往邮件组发信的成员列表，默认展示 10 条，allow_type 为 custom 时才有该字段
∟ ∟ ∟ avatar	string	成员头像链接
∟ ∟ ∟ email_address	string	成员邮箱地址
∟ ∟ ∟ name	string	成员名字
∟ ∟ ∟ type	string[enum]	成员类型 dept：部门；user：用户；mailbox：公共邮箱
∟ ∟ accepted_type	string[enum]	邮件组可发信范围类型 all：所有人；company：当前企业所有人；member：邮件组内成员；custom：自定义
∟ ∟ address	string	地址，形如：user_name@domain
∟ ∟ id	string	id
∟ ∟ members	array[object]	邮件组成员列表，默认展示 10 条
∟ ∟ ∟ avatar	string	成员头像链接
∟ ∟ ∟ email_address	string	成员邮箱地址
∟ ∟ ∟ name	string	成员名字
∟ ∟ ∟ type	string[enum]	成员类型 dept：部门；user：用户；mailbox：公共邮箱
∟ ∟ name	string	名字
∟ ∟ owner	object	邮件组负责人
∟ ∟ ∟ avatar	string	用户的头像链接
∟ ∟ ∟ email_address	string	用户的邮箱地址
∟ ∟ ∟ name	string	名字。创建，更新公共邮箱时无需提供
∟ next_page_token	string	下一页 token
∟ total	integer	总数
more	object	更多的错误信息

响应体示例

{
  "code": 0,
  "data": {
    "items": [
      {
        "accepted_senders": [
          {
            "avatar": "string",
            "email_address": "string",
            "name": "string",
            "type": "string[enum]"
          }
        ],
        "accepted_type": "string[enum]",
        "address": "string",
        "id": "string",
        "members": [
          {
            "avatar": "string",
            "email_address": "string",
            "name": "string",
            "type": "string[enum]"
          }
        ],
        "name": "string",
        "owner": {
          "avatar": "string",
          "email_address": "string",
          "name": "string"
        }
      }
    ],
    "next_page_token": "string",
    "total": 0
  },
  "msg": "string"
}