文档首页/ 华为云会议 Meeting/ 服务端API参考/ 用户管理/ 接口参考/ 邀请用户
更新时间：2024-08-27 GMT+08:00
在线调试
CLI示例
查看PDF
分享

邀请用户

描述

通过手机号码或者邮箱地址邀请用户加入企业。

  • 若被邀请用户在华为云会议系统中不存在，则：
    • 华为云会议免费版和华为云会议Flexus版发送短信/邮件邀请用户完成注册后加入企业。用户注册成功后，加入该企业。
    • 华为云会议旗舰版在企业内直接添加该用户。用户会收到华为云会议的初始密码，用户第一次以手机号或者邮箱登录时，需要修改密码。
  • 若被邀请用户在华为云会议系统中存在，则该用户会收到短信或者邮件确认。确认完成后该用户加入企业内。该用户的密码保持原来的密码不变。

调试

您可以在API Explorer中调试该接口。

接口原型

表1 接口原型

请求方法

POST

请求地址

/v1/usg/dcs/corp/member/add

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

X-Access-Token

是

String

Header

授权令牌。获取“执行App ID鉴权”响应的accessToken。

X-Request-Id

否

String

Header

请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。

Accept-Language

否

String

Header

语言参数，默认为中文zh-CN，英文为en-US。

contact

是

String

Body

后台自动识别是手机还是邮箱，若为手机号，则要求和国家码匹配。

说明：
  • 当前中国站点企业支持使用邮箱或手机号进行邀请，手机仅支持+86开头的手机号。
  • 当前国际站点企业仅支持使用邮箱进行邀请。

country

否

String

Body

手机号所属的国家。

默认值：chinaPR。

maxLength：255

minLength：0

deptCode

否

String

Body

部门编码，若不携带则默认根部门。

desc

否

String

Body

备注。

maxLength：128

minLength：0

name

是

String

Body

企业用户名称。

sortLevel

否

Integer

Body

通讯录排序等级,序号越低优先级越高。

title

否

String

Body

职位。

状态码

表3 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常。

401

未鉴权或鉴权失败。

403

权限受限。

500

服务端异常

响应参数

表4 响应参数

参数

类型

描述

userExist

Boolean

用户是否存在

请求消息示例

POST /v1/usg/dcs/corp/member/add
Connection: keep-alive
Content-Type: application/json
X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9
Content-Length: 173
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{
    "contact": "+8617379679094",
    "country": "chinaPR",
    "name": "张三"
}

响应消息示例

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Server: api-gateway
X-Request-Id: ebbb9b1e50d1ec63b78d8484d170173f

{
    "userExist": false
}

错误码

当您使用华为云会议服务端API时，如果遇到“MMC”或者“USG”开头的错误码，请参考华为云API错误中心。

CURL命令示例

curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9' -d '{"contact": "+8617379679094","country": "chinaPR","name": "张三"}' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/member
父主题： 接口参考

相关文档