该接口用于创建公共邮箱,指定公共邮箱使用权限。
请求方式:POST(HTTPS)
请求地址: https://qyapi.weixin.qq.com/cgi-bin/exmail/publicmail/create?access_token=ACCESS_TOKEN
请求包体
{
"email": "apitest@gzdev.com",
"name": "apitest",
"userid_list": {
"list": ["apitest1", "apitest2"]
},
"department_list": {
"list": [1, 2]
},
"tag_list": {
"list": [1, 2]
},
"create_auth_code": 1,
"auth_code_info" : {
"remark": "客户端专用密码备注"
}
}
参数说明
参数 | 类型 | 是否必须 | 说明 |
---|---|---|---|
string | 是 | 公共邮箱地址 | |
name | string | 是 | 公共邮箱名称,不多于64个字符或32个汉字,不得与其他公共邮箱重名 |
userid_list | string | 否 | 有权限使用公共邮箱的成员UserID列表。userid_list、department_list、taglist不能同时为空 |
department_list | uint32 | 否 | 有权限使用公共邮箱的部门ID列表 |
tag_list | uint32 | 否 | 有权限使用公共邮箱的标签ID列表 |
create_auth_code | uint32 | 否 | 是否创建客户端专用密码,0表示否,1表示是,默认0。客户端专用密码只会显示一次,请在客户端中输入该密码进行验证,每次生成的密码皆可使用,请勿告诉他人 |
auth_code_info.remark | string | 否 | 创建客户端专用密码的备注,仅当设置create_auth_code=1时有效。创建客户端专用密码时未设置备注则默认为"办公PC", 最长不超过128个字节,必须是utf8编码 |
权限说明
返回示例
{
"errcode": 0,
"errmsg": "ok",
"id" : 1,
"auth_code_id" : 1,
"auth_code" : "AUTH_CODE"
}
参数说明
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 错误码 |
errmsg | string | 错误码说明 |
id | uint32 | 公共邮箱ID |
auth_code_id | uint32 | 客户端专用密码ID,仅当设置创建客户端专用密码的时候返回,后续可通过接口删除客户端专用密码 |
auth_code | string | 客户端专用密码, 仅当设置创建客户端专用密码的时候返回,该客户端专用密码仅会返回一次,请妥善存储 |