获取邮箱联系人列表
标签:邮箱联系人
请求说明
字段 | 值 |
---|---|
请求地址 | https://openapi.wps.cn/v7/mail_contacts |
HTTP 方法 | GET |
接口描述 | 获取在当前企业范围内邮箱联系人列表 |
签名方式 | KSO-1 |
限频策略 | 无 |
权限要求 | 查询和管理邮箱联系人(应用授权) kso.mail_contact.readwrite 查询邮箱联系人(应用授权) kso.mail_contact.read |
查询参数 (Query)
属性名 | 类型 | 是否必填 | 描述 | 可选值 |
---|---|---|---|---|
page_size | integer | 否 | 分页大小 | - |
page_token | string | 否 | 翻页token,获取首页无需提供 | - |
with_total | boolean | 否 | 是否返回total字段,默认不返回 | - |
contact_ids | array | 否 | 邮箱联系人ID列表,传入多个时以英文逗号','分隔。指定id获取时会忽略分页参数,且不会进行分页返回。 | - |
响应体(Response)
HTTP状态码: 200
响应体格式: application/json
没有可用的数据
响应体示例
json
{
"data": {
"items": [
{
"department": "string",
"email_address": "string",
"id": "string",
"job_title": "string",
"mobile_phone": "string",
"name": "string",
"organization": "string",
"remark": "string"
}
],
"next_page_token": "string",
"total": 0
},
"code": 0,
"msg": "string"
}