• Enums
  • Enumeration: BroadcastMemberResult
    • Table of contents
    • Enumeration Members
• Interfaces
  • Interface: BroadcastMember
    • Table of contents
    • Properties
  • Interface: BroadcastMemberState
    • Table of contents
    • Properties
  • Interface: BroadcastTask
    • Table of contents
    • Properties
  • Interface: BroadcastTaskState
    • Table of contents
    • Properties
  • Interface: Session
    • Table of contents
    • Properties
• uftbcapi
  • Table of contents
    • Enumerations
    • Interfaces
    • Functions
  • Functions
    • keepalive
    • login
    • logout
    • queryBroadcast
    • startBroadcast

Enums

Enumeration: BroadcastMemberResult

广播成员通知结果

Table of contents

Enumeration Members

• CONNECTED
• DONE
• TRY

Enumeration Members

CONNECTED

• CONNECTED

话机已接通

DONE

• DONE

通知完成

TRY

• TRY

尝试通知，未接通

Interfaces

Interface: BroadcastMember

广播任务通知成员

Table of contents

Properties

• confirmDone
• confirmToPlay
• memberName
• memberNumber
• repeatTimes

Properties

confirmDone

• confirmDone: boolean

成员是否可以按键确认收到按键通知

confirmToPlay

• confirmToPlay: boolean

成员收听前是否要按键确认

memberName

• memberName: string

成员名称

memberNumber

• memberNumber: string

成员电话号码

repeatTimes

• repeatTimes: number

最大重复播放次数

Interface: BroadcastMemberState

广播成员通知状态

Table of contents

Properties

• confirmDone
• confirmToPlay
• idTask
• memberAnsweredTime
• memberBroadcastTime
• memberConfirmedTime
• memberName
• memberNumber
• repeatTimes
• result
• retryCount

Properties

confirmDone

• confirmDone: boolean

成员是否可以按键确认收到按键通知

confirmToPlay

• confirmToPlay: boolean

成员收听前是否要按键确认

idTask

• idTask: number

任务ID

memberAnsweredTime

• memberAnsweredTime: string

接通时间

memberBroadcastTime

• memberBroadcastTime: string

通知语音播放时间

memberConfirmedTime

• memberConfirmedTime: string

确认收到通知时间

memberName

• memberName: string

成员名称

memberNumber

• memberNumber: string

成员号码

repeatTimes

• repeatTimes: number

最大重复播放次数

result

• result: BroadcastMemberResult

通知结果

retryCount

• retryCount: number

重复尝试呼叫计次

Interface: BroadcastTask

广播任务,字段对应API协议文档

Table of contents

Properties

• broadcastContent
• expiredMinutes
• maxTry
• members
• tag

Properties

broadcastContent

• broadcastContent: string

播放文字内容

expiredMinutes

• expiredMinutes: number

任务失效超时分钟数

maxTry

• maxTry: number

最大尝试呼叫次数

members

• members: BroadcastMember[]

通知成员列表

tag

• tag: string

任务标记

Interface: BroadcastTaskState

广播通知任务状态

Table of contents

Properties

• broadcastContent
• finish
• members
• voiceRelativePath

Properties

broadcastContent

• broadcastContent: string

广播内容

finish

• finish: boolean

任务是否完成

members

• members: BroadcastMemberState

成员通知状态

voiceRelativePath

• voiceRelativePath: string

合成语音文件相对路径

Interface: Session

会话参数

Table of contents

Properties

• auth_id
• bizCode
• host
• lastRequestIndex
• port
• username

Properties

auth_id

• auth_id: string

访问认证码

bizCode

• bizCode: string

密码

host

• host: string

主机地址

lastRequestIndex

• lastRequestIndex: number

请求顺序号

port

• port: number

服务器端口

username

• username: string

用户名

uftbcapi

Table of contents

Enumerations

• BroadcastMemberResult

Interfaces

• BroadcastMember
• BroadcastMemberState
• BroadcastTask
• BroadcastTaskState
• Session

Functions

• keepalive
• login
• logout
• queryBroadcast
• startBroadcast

Functions

keepalive

▸ keepalive(): Promise<void>

会话心跳保持

Returns

Promise<void>

无

login

▸ login(host, port, username, bizCode, keepaliveInMinutes): Promise<void>

登录服务器

Parameters

| Name | Type | Description | | :------ | :------ | :------ | | host | string | 服务器地址 | | port | number | 服务器端口 | | username | string | 用户账号 | | bizCode | string | 登录密码 | | keepaliveInMinutes | number | 会话保持心跳周期(分钟) |

Returns

Promise<void>

无

logout

▸ logout(): Promise<void>

登出服务器

Returns

Promise<void>

无

queryBroadcast

▸ queryBroadcast(broadcastId): Promise<BroadcastTaskState>

查询广播任务状态

Parameters

| Name | Type | Description | | :------ | :------ | :------ | | broadcastId | number | 任务ID |

Returns

Promise<BroadcastTaskState>

任务状态

startBroadcast

▸ startBroadcast(task): Promise<number>

启动广播任务

Parameters

| Name | Type | Description | | :------ | :------ | :------ | | task | BroadcastTask | 任务数据对象 |

Returns

Promise<number>

任务ID,数值类型