uftcsapi_dev v1.0.0
- Enums
- uftcsapi
- Table of contents
- Type Aliases
- Functions
- conferenceAdd
- conferenceCallInForbidden
- conferenceControlStart
- conferenceControlStop
- conferenceDel
- conferenceInviteAll
- conferenceKeepInvite
- conferenceList
- conferenceLoad
- conferenceMemberBye
- conferenceMemberDel
- conferenceMemberInvite
- conferenceMemberSetName
- conferenceMemberSetType
- conferenceRecording
- conferenceSave
- conferenceSetStyle
- conferenceStart
- conferenceStatePoll
- conferenceStop
- conferenceSurveillance
- conferenceUpdate
- getServerAddress
- keepalive
- login
- logout
- setServerAddress
Enums
Enumeration: ConferenceStyle
会议类型
Table of contents
Enumeration Members
Enumeration Members
Broadcast
• Broadcast = 1
广播模式
Interactive
• Interactive = 0
自由讨论模式（默认）
Enumeration: MemberCallState
会议成员呼叫状态
Table of contents
Enumeration Members
Enumeration Members
Alert
• Alert = 2
振铃中
Connected
• Connected = 3
通话中
Idle
• Idle = 0
空闲
Proceeding
• Proceeding = 1
正在呼叫中
Enumeration: MemberType
会议成员类型
Table of contents
Enumeration Members
Enumeration Members
Audience
• Audience = 0
普通听众
Chairman
• Chairman = 2
会议主持
Dispatcher
• Dispatcher = 3
调度操作员
Speaker
• Speaker = 1
发言者
Enumeration: RepeatPeriod
预约会议重复周期
Table of contents
Enumeration Members
Enumeration Members
Day
• Day = 0
每天
Month
• Month = 2
每月
Specified
• Specified = 4
自定义
Week
• Week = 1
每周
Year
• Year = 3
每年
Enumeration: SpeakReqMode
发言请求模式
Table of contents
Enumeration Members
Enumeration Members
Password
• Password = 1
密码触发模式
RaiseHand
• RaiseHand = 0
举手申请模式(默认)
uftcsapi
Table of contents
Enumerations
Type Aliases
- ConferenceConfig
- ConferenceDetailState
- ConferenceProfile
- ConferenceState
- ConferenceStateCallbacks
- Member
- MemberInvite
- MemberState
- Session
Functions
- conferenceAdd
- conferenceCallInForbidden
- conferenceControlStart
- conferenceControlStop
- conferenceDel
- conferenceInviteAll
- conferenceKeepInvite
- conferenceList
- conferenceLoad
- conferenceMemberBye
- conferenceMemberDel
- conferenceMemberInvite
- conferenceMemberSetName
- conferenceMemberSetType
- conferenceRecording
- conferenceSave
- conferenceSetStyle
- conferenceStart
- conferenceStatePoll
- conferenceStop
- conferenceSurveillance
- conferenceUpdate
- getServerAddress
- keepalive
- login
- logout
- setServerAddress
Type Aliases
ConferenceConfig
Ƭ ConferenceConfig: Object
会议室配置
Type declaration
| Name | Type | Description |
|---|---|---|
autoRecord | boolean | 是否自动录音 |
backgroundMusic | boolean | 是否播放背景音乐 |
callInDoubleCheck | boolean | 预设号码呼入是否要验证密码 |
callInForbidden | boolean | 是否禁止非预设号码呼入 |
creator? | string | 创建用户ID |
dispatcherControlStart | boolean | 调度员呼入是否自动开始会议 |
dispatcherControlStop | boolean | 调度员挂机是否结束会议 |
id? | number | 会议室ID,系统统一自动分配 |
keepInvite | boolean | 是否自动追呼 |
members | Member[] | 成员列表 |
pwdAudience | string | 听众密码 |
pwdDispatcher | string | 调度员密码 |
pwdSpeaker | string | 发言者密码 |
schedule? | { period: RepeatPeriod ; times: { day?: number ; hour: number ; minute: number ; month?: number ; weekDay?: number ; year?: number }[] } | 定时会议预约参数,可选字段,非预约会议无此字段 |
schedule.period | RepeatPeriod | 重复周期 |
schedule.times | { day?: number ; hour: number ; minute: number ; month?: number ; weekDay?: number ; year?: number }[] | 重复时间列表,period=Specified时允许多项,否则只有1项 |
speakReqMode | SpeakReqMode | 发言请求模式 |
style | ConferenceStyle | 会议模式 |
topic | string | 会议主题说明 |
ConferenceDetailState
Ƭ ConferenceDetailState: Object
会议室实时详细状态
Type declaration
| Name | Type | Description |
|---|---|---|
members | Member[] | 成员状态列表 |
overall | ConferenceState | 总体状态 |
ConferenceProfile
Ƭ ConferenceProfile: Object
会议室配置概览
Type declaration
| Name | Type | Description |
|---|---|---|
id | number | 会议室ID |
memberNumber | number | 预设成员总数 |
period? | RepeatPeriod | 定时会议预约周期,可选字段,非预约会议无此字段 |
style | ConferenceStyle | 会议模式 |
topic | string | 会议主题说明 |
ConferenceState
Ƭ ConferenceState: Object
会议室实时状态
Type declaration
| Name | Type | Description |
|---|---|---|
callInForbidden | boolean | 是否禁止非预设号码呼入 |
connectedCount | number | 接通成员数 |
id | number | 会议室ID |
keepInvite | boolean | 是否自动追呼 |
memberCount | number | 实际会议成员数 |
recording | boolean | 是否在录音 |
startTime | number | 会议开始时间戳 |
style | ConferenceStyle | 会议模式 |
ConferenceStateCallbacks
Ƭ ConferenceStateCallbacks: Object
控制中会议状态事件回调函数
Type declaration
| Name | Type |
|---|---|
onCallInForbidden? | (enable: boolean) => void |
onKeepInvite? | (enable: boolean) => void |
onMember? | (telnumber: string, state: MemberState) => void |
onMemberDel? | (telnumber: string) => void |
onRecording? | (on: boolean) => void |
onStop | () => void |
onStyle? | (style: ConferenceStyle) => void |
Member
Ƭ Member: Object
会议成员配置
Type declaration
| Name | Type | Description |
|---|---|---|
callState? | MemberCallState | 成员呼叫状态 |
isIncome? | boolean | 是否呼入 |
name | string | 成员名称 |
telnumber | string | 成员电话号码 |
type | MemberType | 成员身份类型 |
MemberInvite
Ƭ MemberInvite: Object
邀请会议成员参数
Type declaration
| Name | Type | Description |
|---|---|---|
name? | string | 名称,可缺省 |
telnumber | string | 电话号码 |
type? | MemberType | 身份类型, 缺省时默认值根据会议模式确定,交互会议时为发言人,广播会议时为普通听众 |
MemberState
Ƭ MemberState: Object
会议成员状态
Type declaration
| Name | Type | Description |
|---|---|---|
callState? | MemberCallState | 呼叫状态 |
inCom? | boolean | 是否呼入成员 |
name? | string | 成员名称 |
type? | MemberType | 成员身份类型 |
Session
Ƭ Session: Object
终端登录会话状态数据结构
Type declaration
| Name | Type | Description |
|---|---|---|
administrator | boolean | 登录用户是否管理员 |
auth_id | string | 登录认证成功后返回的会话ID |
errMsg | string | 服务器最近返回错误信息 |
inProgress | boolean | 是否正在登录 |
lastRequestIndex | number | 最近发送请求序号 |
pwd | string | 用户登录密码 |
rights | { [key: string]: boolean; } | 登录用户操作权限集合 |
userId | string | 用户状态 |
userName | string | 用户名称 |
Functions
conferenceAdd
▸ conferenceAdd(cfg): Promise<number>
新建会议室
Parameters
| Name | Type | Description |
|---|---|---|
cfg | ConferenceConfig | 会议室配置参数 ConferenceConfig |
Returns
Promise<number>
系统自动生成的唯一性ID
conferenceCallInForbidden
▸ conferenceCallInForbidden(enable): Promise<void>
会议中设置是否禁止非预设成员呼入
Parameters
| Name | Type | Description |
|---|---|---|
enable | boolean | 是否禁止呼入 |
Returns
Promise<void>
conferenceControlStart
▸ conferenceControlStart(id, callbacks): Promise<ConferenceDetailState>
会议室启动控制
Parameters
| Name | Type | Description |
|---|---|---|
id | number | 会议室ID |
callbacks | ConferenceStateCallbacks | 会议实时状态刷新事件回调函数 |
Returns
Promise<ConferenceDetailState>
会议初始详细状态 ConferenceDetailState
conferenceControlStop
▸ conferenceControlStop(): Promise<void>
会议室释放控制
Returns
Promise<void>
conferenceDel
▸ conferenceDel(id): Promise<void>
删除会议室
Parameters
| Name | Type | Description |
|---|---|---|
id | number | 会议室ID |
Returns
Promise<void>
conferenceInviteAll
▸ conferenceInviteAll(): Promise<void>
会议中启动群呼
Returns
Promise<void>
conferenceKeepInvite
▸ conferenceKeepInvite(enable): Promise<void>
会议中设置会议成员自动追呼
Parameters
| Name | Type | Description |
|---|---|---|
enable | boolean | 是否自动追呼 |
Returns
Promise<void>
conferenceList
▸ conferenceList(offset, rows, filterByTopic?): Promise<ConferenceProfile[]>
会议室列表
Parameters
| Name | Type | Description |
|---|---|---|
offset | number | 返回记录起始偏移量 |
rows | number | 最大返回项目数 |
filterByTopic? | string | 按主题搜索过滤字符串(拼音首字母前缀或主题文字) |
Returns
Promise<ConferenceProfile[]>
会议室概览数据列表 ConferenceProfile[]
conferenceLoad
▸ conferenceLoad(id): Promise<ConferenceConfig>
加载会议室详细配置
Parameters
| Name | Type | Description |
|---|---|---|
id | number | 会议室ID |
Returns
Promise<ConferenceConfig>
会议室配置数据 ConferenceConfig
conferenceMemberBye
▸ conferenceMemberBye(telnumber): Promise<void>
会议中拆除会议成员
Parameters
| Name | Type | Description |
|---|---|---|
telnumber | string | 成员电话号码 |
Returns
Promise<void>
conferenceMemberDel
▸ conferenceMemberDel(telnumber): Promise<void>
会议中删除会议成员
Parameters
| Name | Type | Description |
|---|---|---|
telnumber | string | 成员电话号码 |
Returns
Promise<void>
conferenceMemberInvite
▸ conferenceMemberInvite(member): Promise<void>
会议中邀请会议成员
Parameters
| Name | Type | Description |
|---|---|---|
member | MemberInvite | 会议成员配置参数 MemberInvite |
Returns
Promise<void>
conferenceMemberSetName
▸ conferenceMemberSetName(telnumber, name): Promise<void>
会议中命名会议成员
Parameters
| Name | Type | Description |
|---|---|---|
telnumber | string | 成员电话号码 |
name | string | 成员名称 |
Returns
Promise<void>
conferenceMemberSetType
▸ conferenceMemberSetType(telnumber, type): Promise<void>
会议中设置会议成员类型
Parameters
| Name | Type | Description |
|---|---|---|
telnumber | string | 成员电话号码 |
type | MemberType | 会议成员类型 MemberType |
Returns
Promise<void>
conferenceRecording
▸ conferenceRecording(enable): Promise<void>
会议中启动/停止录音
Parameters
| Name | Type | Description |
|---|---|---|
enable | boolean | 是否录音 |
Returns
Promise<void>
conferenceSave
▸ conferenceSave(): Promise<void>
保存控制中会议室配置
Returns
Promise<void>
conferenceSetStyle
▸ conferenceSetStyle(style): Promise<void>
会议中改变会议模式
Parameters
| Name | Type | Description |
|---|---|---|
style | ConferenceStyle | 会议模式 ConferenceStyle |
Returns
Promise<void>
conferenceStart
▸ conferenceStart(id): Promise<void>
开始会议
Parameters
| Name | Type | Description |
|---|---|---|
id | number | 会议室ID |
Returns
Promise<void>
conferenceStatePoll
▸ conferenceStatePoll(ids): Promise<ConferenceState[]>
会议室实时状态查询
Parameters
| Name | Type | Description |
|---|---|---|
ids | number[] | 欲查询会议室ID列表 |
Returns
Promise<ConferenceState[]>
会议室状态列表,未开始的会议不返回对应项 ConferenceState[]
conferenceStop
▸ conferenceStop(id): Promise<void>
结束会议
Parameters
| Name | Type | Description |
|---|---|---|
id | number | 会议室ID |
Returns
Promise<void>
conferenceSurveillance
▸ conferenceSurveillance(id, monitorTelNumber): Promise<void>
会议室秘密监听
Parameters
| Name | Type | Description |
|---|---|---|
id | number | 会议室ID |
monitorTelNumber | string | 监听用电话号码 |
Returns
Promise<void>
conferenceUpdate
▸ conferenceUpdate(cfg): Promise<void>
更新会议室配置
Parameters
| Name | Type | Description |
|---|---|---|
cfg | ConferenceConfig | 会议室ID及配置参数 ConferenceConfig |
Returns
Promise<void>
getServerAddress
▸ getServerAddress(): Object
Returns
Object
服务器地址 {hostAddr,ssl}
| Name | Type |
|---|---|
hostAddr | string |
ssl | boolean |
keepalive
▸ keepalive(): Promise<void>
会话心跳保持
Returns
Promise<void>
无
login
▸ login(acc, password, onSessionDown?): Promise<undefined | Session>
登录服务器后台
Parameters
| Name | Type | Description |
|---|---|---|
acc | string | 登录账号 |
password | string | 登录密码 |
onSessionDown? | (e: { result: string ; resultComment: string }) => void | 会话中断回调事件函数 |
Returns
Promise<undefined | Session>
会话数据结构
logout
▸ logout(): void
登出系统
Returns
void
无
setServerAddress
▸ setServerAddress(hostAddr, ssl): void
初始化服务器URL地址
Parameters
| Name | Type | Description |
|---|---|---|
hostAddr | string | 服务器IP地址:端口,例如192.168.1.88:3000 |
ssl | boolean | 是否采用SSL加密协议 |
Returns
void
2 years ago