Uftcsapi NPM | npm.io

Enums
uftcsapi

Enums

Enumeration: ConferenceStyle

会议类型

Enumeration Members

Broadcast
Interactive

Enumeration Members

Broadcast

• Broadcast = 1

广播模式

Interactive

• Interactive = 0

自由讨论模式（默认）

Enumeration: MemberCallState

会议成员呼叫状态

Enumeration Members

Alert
Connected
Idle
Proceeding

Enumeration Members

Alert

• Alert = 2

振铃中

Connected

• Connected = 3

通话中

Idle

• Idle = 0

空闲

Proceeding

• Proceeding = 1

正在呼叫中

Enumeration: MemberType

会议成员类型

Enumeration Members

Audience

• Audience = 0

普通听众

Chairman

• Chairman = 2

会议主持

Dispatcher

• Dispatcher = 3

调度操作员

Speaker

• Speaker = 1

发言者

Enumeration: MsgCatalog

消息类别

Enumeration Members

Event
Request
Response

Enumeration Members

Event

• Event = 2

事件消息

Request

• Request = 0

请求消息

Response

• Response = 1

响应消息

Enumeration: MsgTypes

协议消息类型ID

Enumeration Members

CmdConferenceBackgroundMusic
CmdConferenceCallInForbidden
CmdConferenceGetDetail
CmdConferenceInviteAll
CmdConferenceKeepInvite
CmdConferenceRecord
CmdConferenceSave
CmdConferenceSetStyle
CmdKeepAlive
CmdMemberBye
CmdMemberDel
CmdMemberInvite
CmdMemberSetName
CmdMemberSetType
EvtConferenceBackgroudMusic
EvtConferenceCallInForbidden
EvtConferenceKeepInvite
EvtConferenceRecord
EvtConferenceStop
EvtConferenceStyle
EvtMemberDel
EvtMemberState
RespApiObjID
RespError
RespOK

Enumeration Members

CmdConferenceBackgroundMusic

• CmdConferenceBackgroundMusic = 10

CmdConferenceCallInForbidden

• CmdConferenceCallInForbidden = 8

CmdConferenceGetDetail

• CmdConferenceGetDetail = 4

CmdConferenceInviteAll

• CmdConferenceInviteAll = 11

CmdConferenceKeepInvite

• CmdConferenceKeepInvite = 7

CmdConferenceRecord

• CmdConferenceRecord = 9

CmdConferenceSave

• CmdConferenceSave = 5

CmdConferenceSetStyle

• CmdConferenceSetStyle = 6

CmdKeepAlive

• CmdKeepAlive = 3

CmdMemberBye

• CmdMemberBye = 14

CmdMemberDel

• CmdMemberDel = 13

CmdMemberInvite

• CmdMemberInvite = 12

CmdMemberSetName

• CmdMemberSetName = 16

CmdMemberSetType

• CmdMemberSetType = 15

EvtConferenceBackgroudMusic

• EvtConferenceBackgroudMusic = 22

EvtConferenceCallInForbidden

• EvtConferenceCallInForbidden = 20

EvtConferenceKeepInvite

• EvtConferenceKeepInvite = 19

EvtConferenceRecord

• EvtConferenceRecord = 21

EvtConferenceStop

• EvtConferenceStop = 17

EvtConferenceStyle

• EvtConferenceStyle = 18

EvtMemberDel

• EvtMemberDel = 24

EvtMemberState

• EvtMemberState = 23

RespApiObjID

• RespApiObjID = 1

RespError

• RespError = 2

RespOK

• RespOK = 0

Enumeration: RepeatPeriod

预约会议重复周期

Enumeration Members

Day
Month
Once
Week
Year

Enumeration Members

Day

• Day = 0

每天

Month

• Month = 2

每月

Once

• Once = 4

单次

Week

• Week = 1

每周

Year

• Year = 3

每年

Enumeration: SpeakReqMode

发言请求模式

Enumeration Members

Password
RaiseHand

Enumeration Members

Password

• Password = 1

密码触发模式

RaiseHand

• RaiseHand = 0

举手申请模式(默认)

uftcsapi

Type Aliases

ConferenceConfig

Ƭ ConferenceConfig: Object

会议室配置

Type declaration

Name	Type	Description
`autoRecord`	`boolean`	是否自动录音
`backgroundMusic`	`boolean`	是否播放背景音乐
`callInDoubleCheck`	`boolean`	预设号码呼入是否要验证密码
`callInForbidden`	`boolean`	是否禁止非预设号码呼入
`dispatcherControlStart`	`boolean`	调度员呼入是否自动开始会议
`dispatcherControlStop`	`boolean`	调度员挂机是否结束会议
`id?`	`number`	会议室ID,系统统一自动分配
`indexTags?`	`string`	自定义主题索引,允许多个以逗号分开
`keepInvite`	`boolean`	是否自动追呼
`members`	`Member`[]	成员列表
`owner?`	`string`	归属用户ID
`pwdAudience`	`string`	听众密码
`pwdDispatcher`	`string`	调度员密码
`pwdSpeaker`	`string`	发言者密码
`schedule?`	`ScheduleItem`[]	定时会议预约参数
`speakReqMode`	`SpeakReqMode`	发言请求模式
`style`	`ConferenceStyle`	会议模式
`topic?`	`string`	会议主题说明

ConferenceDetailState

Ƭ ConferenceDetailState: Object

会议室实时详细状态

Type declaration

Name	Type	Description
`members`	`MemberState`[]	成员状态列表
`overall`	`ConferenceState`	总体状态

ConferenceProfile

Ƭ ConferenceProfile: Object

会议室配置概览

Type declaration

Name	Type	Description
`createTime`	`string`	创建时间
`id`	`number`	会议室ID
`memberNumber`	`number`	预设成员总数
`owner`	`string`	归属用户
`style`	`ConferenceStyle`	会议模式
`topic`	`string`	会议主题说明

ConferenceState

Ƭ ConferenceState: Object

会议室实时状态

Type declaration

Name	Type	Description
`backgroudMusic`	`boolean`	是否在播放背景音乐
`callInForbidden`	`boolean`	是否禁止非预设号码呼入
`connectedCount`	`number`	接通成员数
`keepInvite`	`boolean`	是否自动追呼
`memberCount`	`number`	实际会议成员数
`recording`	`boolean`	是否在录音
`startTime`	`number`	会议开始时间戳
`style`	`ConferenceStyle`	会议模式

ConferenceStateCallbacks

Ƭ ConferenceStateCallbacks: Object

控制中会议状态事件回调函数

Type declaration

Name	Type
`onBackgroundMusic?`	(`on`: `boolean`) => `void`
`onCallInForbidden?`	(`enable`: `boolean`) => `void`
`onControlDown`	(`cause`: `string`) => `void`
`onKeepInvite?`	(`enable`: `boolean`) => `void`
`onMember?`	(`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
`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`	成员名称
`raiseHand?`	`boolean`	是否举手请求发言
`telNumber`	`string`	成员电话号码
`type?`	`MemberType`	成员身份类型

Message

Ƭ Message: Object

协议消息结构

Type declaration

Name	Type	Description
`Catalog`	`MsgCatalog`	消息分类
`ErrorMsg?`	`string`	出错信息
`InvokeID`	`number`	调用ID
`MsgType`	`MsgTypes`	消息具体类型
`Param?`	`any`	调用参数
`Ret?`	`any`	调用返回结果

ResultOfConferenceList

Ƭ ResultOfConferenceList: Object

会议室检索列表返回结果数据结构

Type declaration

Name	Type	Description
`items`	`ConferenceProfile`[]	会议室项目列表(offset,rows范围)
`total`	`number`	满足检索条件会议室项目总数

ResultOfUserList

Ƭ ResultOfUserList: Object

用户检索列表返回结果数据结构

Type declaration

Name	Type	Description
`items`	`User`[]	用户项目列表(offset,rows范围)
`total`	`number`	满足检索条件用户项目总数

ScheduleItem

Ƭ ScheduleItem: Object

定时会议预约项

Type declaration

Name	Type	Description
`day?`	`number`	日期,period=Year\|Month\|Once时需要
`hour`	`number`	小时
`minute`	`number`	分钟
`month?`	`number`	月,period=Year\|Once时需要
`period`	`RepeatPeriod`	重复周期
`weekDay?`	`number`	星期,period=Week时需要
`year?`	`number`	年,period=Once时需要

Session

Ƭ Session: Object

终端登录会话状态数据结构

Type declaration

Name	Type	Description
`administrator`	`boolean`	登录用户是否管理员
`auth_id`	`string`	登录认证成功后返回的会话ID
`errMsg`	`string`	服务器最近返回错误信息
`inProgress`	`boolean`	是否正在登录
`lastRequestIndex`	`number`	最近发送请求序号
`pwd`	`string`	用户登录密码
`userId`	`string`	用户状态
`userName`	`string`	用户名称

StorageStateSummary

Ƭ StorageStateSummary: Object

数据存储状态配置

Type declaration

Name	Type	Description
`recordTotalTime`	`string`	录音净时长总计
`remainDuration`	`string`	剩余可存储时长
`storageAutoClean`	`boolean`	硬盘是否自动清理
`storageAutoCleanTimePerDay`	`number`	硬盘自动清理时间
`storageKeepDays`	`number`	历史存储记录保存天数
`storageTotal`	`number`	数据硬盘总容量
`storageUsed`	`number`	数据硬盘占用
`storedDuration`	`string`	记录已存储时长

SystemStateSummary

Ƭ SystemStateSummary: Object

系统状态概览数据结构

Type declaration

Name	Type	Description
`conferenceTotal`	`number`	占用会议室总数
`partyTotal`	`number`	会议授权总方数
`partyUsed`	`number`	会议占用总方数
`system`	{ `cpuUsed`: `number` ; `memoryTotal`: `number` ; `memoryUsed`: `number` ; `storageTotal`: `number` ; `storageUsed`: `number` }	系统资源
`system.cpuUsed`	`number`	CPU占用
`system.memoryTotal`	`number`	内存总数
`system.memoryUsed`	`number`	内存占用
`system.storageTotal`	`number`	数据硬盘总容量
`system.storageUsed`	`number`	数据硬盘占用

User

Ƭ User: Object

用户账号

Type declaration

Name	Type	Description
`administrator`	`boolean`	是否管理员用户
`bizCode?`	`string`	登录密码
`createTime?`	`string` \| `Date`	创建时间
`enabled`	`boolean`	是否启用
`id?`	`string`	登录ID
`indexTags?`	`string`	自定义用户索引,允许多个以逗号分开
`name`	`string`	名称
`namePy?`	`string`	名称拼音首字母

UserState

Ƭ UserState: Object

用户登录状态

Type declaration

Name	Type	Description
`conference?`	{ `id`: `number` ; `topic`: `string` }	控制会议室
`conference.id`	`number`	会议室ID
`conference.topic`	`string`	会议主题
`ipAddr`	`string`	终端IP地址
`loginDuration`	`string`	登录时长
`loginTime`	`string`	登录时间

Functions

conferenceAdd

▸ conferenceAdd(config): Promise<number>

新建会议室

Parameters

Name	Type	Description
`config`	`ConferenceConfig`	会议室配置参数 ConferenceConfig

Returns

Promise<number>

系统自动生成的唯一性ID

conferenceBackgroundMusic

▸ conferenceBackgroundMusic(enable): Promise<void>

会议中启动/停止背景音乐

Parameters

Name	Type	Description
`enable`	`boolean`	是否播放背景音乐

Returns

Promise<void>

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<ResultOfConferenceList>

会议室列表

Parameters

Name	Type	Description
`offset`	`number`	返回记录起始偏移量
`rows`	`number`	最大返回项目数
`filterByTopic?`	`string`	按主题搜索过滤字符串(拼音首字母前缀或主题文字)

Returns

Promise<ResultOfConferenceList>

会议室概览数据列表 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<{ [key: string]: ConferenceState; }>

会议室实时状态查询

Parameters

Name	Type	Description
`ids`	`number`[]	欲查询会议室ID列表

Returns

Promise<{ [key: string]: ConferenceState; }>

会议室状态映射表,未开始的会议不返回对应项　{ ID: string: 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(config): Promise<void>

更新会议室配置

Parameters

Name	Type	Description
`config`	`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

storageClean

▸ storageClean(password): Promise<void>

清理存储空间

Parameters

Name	Type	Description
`password`	`string`	登录用户密码

Returns

Promise<void>

storageClear

▸ storageClear(password): Promise<void>

初始化存储空间

Parameters

Name	Type	Description
`password`	`string`	登录用户密码

Returns

Promise<void>

storageConfig

▸ storageConfig(password, autoClean, cleanHourPerDay?, keepDays?): Promise<void>

配置存储空间管理参数

Parameters

Name	Type	Description
`password`	`string`	登录用户密码
`autoClean`	`boolean`	后台自动清理
`cleanHourPerDay?`	`number`	每天清理空间时间
`keepDays?`	`number`	历史记录保持天数

Returns

Promise<void>

storageStateSummaryPoll

▸ storageStateSummaryPoll(): Promise<StorageStateSummary>

轮询存储状态

Returns

Promise<StorageStateSummary>

存储状态概览StorageStateSummary

systemStateSummaryPoll

▸ systemStateSummaryPoll(): Promise<SystemStateSummary>

轮询系统状态

Returns

Promise<SystemStateSummary>

系统状态概览SystemStateSummary

userAdd

▸ userAdd(config): Promise<void>

新建用户

Parameters

Name	Type	Description
`config`	`User`	用户配置参数 User

Returns

Promise<void>

userDel

▸ userDel(ids): Promise<void>

删除用户

Parameters

Name	Type	Description
`ids`	`string`[]	用户ID列表

Returns

Promise<void>

userDisable

▸ userDisable(ids): Promise<void>

禁用用户

Parameters

Name	Type	Description
`ids`	`string`[]	用户ID列表

Returns

Promise<void>

userEnable

▸ userEnable(ids): Promise<void>

启用用户

Parameters

Name	Type	Description
`ids`	`string`[]	用户ID列表

Returns

Promise<void>

userList

▸ userList(offset, rows, filter?): Promise<ResultOfUserList>

用户列表

Parameters

Name	Type	Description
`offset`	`number`	返回记录起始偏移量
`rows`	`number`	最大返回项目数
`filter?`	`string`	按主题搜索过滤字符串(拼音首字母前缀或主题文字)

Returns

Promise<ResultOfUserList>

用户概览数据列表 User[]

userReset

▸ userReset(ids): Promise<void>

重置用户密码

Parameters

Name	Type	Description
`ids`	`string`[]	用户ID列表

Returns

Promise<void>

userSetPassword

▸ userSetPassword(oldPass, newPass): Promise<void>

设置当前用户登录密码

Parameters

Name	Type	Description
`oldPass`	`string`	原密码
`newPass`	`string`	新密码

Returns

Promise<void>

userStatePoll

▸ userStatePoll(ids): Promise<{ [userId: string]: UserState; }>

用户实时状态查询

Parameters

Name	Type	Description
`ids`	`string`[]	欲查询用户ID列表

Returns

Promise<{ [userId: string]: UserState; }>

用户登录状态映射表,未登录用户不返回对应项 { userId: string: UserState }

userUpdate

▸ userUpdate(config): Promise<void>

更新用户配置

Parameters

Name	Type	Description
`config`	`User`	用户ID及配置参数 User

Returns

Promise<void>

axios js-md5 ufpdssessapi

@infinitebrahmanuniverse/nolb-uf @everything-registry/sub-chunk-3003

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

Enums

Enumeration: ConferenceStyle

Table of contents

Enumeration Members

Enumeration Members

Broadcast

Interactive

Enumeration: MemberCallState

Table of contents

Enumeration Members

Enumeration Members

Alert

Connected

Idle

Proceeding

Enumeration: MemberType

Table of contents

Enumeration Members

Enumeration Members

Audience

Chairman

Dispatcher

Speaker

Enumeration: MsgCatalog

Table of contents

Enumeration Members

Enumeration Members

Event

Request

Response

Enumeration: MsgTypes

Table of contents

Enumeration Members

Enumeration Members

CmdConferenceBackgroundMusic

CmdConferenceCallInForbidden

CmdConferenceGetDetail

CmdConferenceInviteAll

CmdConferenceKeepInvite

CmdConferenceRecord

CmdConferenceSave

CmdConferenceSetStyle

CmdKeepAlive

CmdMemberBye

CmdMemberDel

CmdMemberInvite

CmdMemberSetName

CmdMemberSetType

EvtConferenceBackgroudMusic

EvtConferenceCallInForbidden

EvtConferenceKeepInvite

EvtConferenceRecord

EvtConferenceStop

EvtConferenceStyle

EvtMemberDel

EvtMemberState

RespApiObjID

RespError

RespOK

Enumeration: RepeatPeriod

Table of contents

Enumeration Members

Enumeration Members

Day

Month

Once

Week

Year

Enumeration: SpeakReqMode

Table of contents

Enumeration Members

Enumeration Members

Password

RaiseHand

uftcsapi

Table of contents

Enumerations

Type Aliases

Functions

Type Aliases