应用
打开UME
协议
scheme://host/ume/client/main/open
参数
| 字段 | 必填 | 说明 |
|---|
示例
scheme://host/ume/client/main/open
账号
sso登录
协议
scheme://host/ume/client/account/sso
参数
- 参数自行填充，客户端会透传到服务端进行校验认证
| 字段 | 必填 | 说明 |
|---|
示例
scheme://host/ume/client/account/sso?xxx=xxx&xxx=xxx
会话
打开会话
协议
scheme://host/ume/client/session/open
参数
| 字段 | 必填 | 说明 |
|---|---|---|
| userId | 与sessionId两者必填其一 | 通过联系人ID打开指定会话 |
| sessionId | 与userId两者必填其一 | 通过会话ID打开指定会话 |
示例
scheme://host/ume/client/session/open?sessionId=xxx
群公告详情
协议
scheme://host/ume/client/session/announcement
参数
| 字段 | 必填 | 说明 |
|---|---|---|
| sessionId | 是 | 通过会话ID打开指定会话 |
示例
scheme://host/ume/client/session/announcement?sessionId=xxx
请求经过服务台应用方接入并打开服务台会话
协议
scheme://host/ume/client/session/helpdesk
参数
| 字段 | 必填 | 说明 |
|---|---|---|
| clientId | 是 | 服务台应用ID |
| userId | 是 | 通过服务台联系人ID接入并打开指定服务台会话 |
| extra | 否 | 附带数据，Json格式字符串，将转为字典透传到服务台应用方 |
示例
scheme://host/ume/client/session/helpdesk?clientId=xxx&userId=xxx&extra={"key1":"value1","key2":"value2"}
应用中心
打开应用
协议
scheme://host/ume/client/webapp/open
参数
| 字段 | 必填 | 说明 |
|---|---|---|
| clientId | 是 | 应用ID |
| mode | 否 | 打开方式（优先级最高，链接中未带打开方式参数时取应用配置的打开方式） appCenter: 默认值，应用内打开加载 window: 独立UME窗口打开，仅pc有效 browser: 系统浏览器打开 multiTabWindow: 独立多标签UME窗口打开，仅pc有效 sidebar: 在侧边栏打开，仅pc有效 |
| sidebarScale | 否 | 侧边栏宽度规模，仅当mode为sidebar时有效 normal: 默认值，常规宽度 large: 大尺寸宽度 |
| path | 否 | 访问应用页面的具体某个页面，该参数将替换url的path部分，注意：不能包含#和?字符 |
示例
scheme://host/ume/client/webapp/open?clientId=xxx&mode=appCenter&path=xxx/xxx
内部页面
免登打开页面
协议
scheme://host/ume/client/innerweb/open
参数
| 字段 | 必填 | 说明 |
|---|---|---|
| mode | 否 | 打开方式（优先级最高，链接中未带打开方式参数时取应用配置的打开方式） appCenter: 默认值，应用内打开加载 window: 独立UME窗口打开，仅pc有效 browser: 系统浏览器打开 |
| path | 否 | 访问应用页面的具体某个页面，该参数将替换url的path部分，注意：不能包含#和?字符 |
示例
scheme://host/ume/client/innerweb/open?clientId=xxx&mode=appCenter&path=xxx/xxx
日程
日程详情
协议
scheme://host/ume/client/schedule/detail
参数
| 字段 | 必填 | 说明 |
|---|---|---|
| planId | 是 | 日程ID |
| seq | 否 | 周期日程的序列号，若指定日程为周期日程，填写该字段时，打开该周期日程里对应序列号的单个日程，未填写该字段时，打开该周期日程的第一个未结束日程 |
示例
scheme://host/ume/client/schedule/detail?planId=xxx&seq=0
通话
呼叫
协议
scheme://host/ume/client/call/dial
参数
| 字段 | 必填 | 说明 |
|---|---|---|
| number | 与userId两者必填其一 | 号码，呼叫该号码 |
| userId | 与number两者必填其一 | 联系人ID，呼叫指定联系人的分机号 |
| mode | 否 | 呼叫方式 audio: 默认值，音频呼叫 video: 视频呼叫 |
| authcode | 否 | 鉴权码，携带该参数时客户端会凭该码做自动登录 |
示例
scheme://host/ume/client/call/dial?number=xxx&mode=audio&authcode=xxx
会议
加入会议
协议
scheme://host/ume/client/meeting/join
参数
| 字段 | 必填 | 说明 |
|---|---|---|
| meetingId | 是 | 会议号 |
| password | 否 | 会议密码 |
| openCamera | 否 | 是否开启摄像头 true: 开启 false: 关闭 |
| openMicrophone | 否 | 是否开启麦克风 true: 开启 false: 关闭 |
| preview | 否 | 是否入会前要预览 true: 入会前预览 false: 直接入会 |
| authcode | 否 | 鉴权码，携带该参数时客户端会凭该码做自动登录，未登录且未携带该码则触发未登录入会 |
示例
scheme://host/ume/client/meeting/join?meetingId=xxx&password=xxx&openCamera=true&openMicrophone=true&preview=true&&authcode=xxx