呼叫中心呼叫参数配置类 JCCGuestCallParam

用于配置访客呼叫客服时的各种参数,包括通话质量、媒体编码、录制配置、心跳设置等。 通过合理配置这些参数,可以控制通话质量、安全性和系统稳定性。

// 创建呼叫参数对象
const callParam = new JCCGuestCallParam();

// 配置视频相关参数
callParam.captureResolutionType = JResolution.RESOLUTION_720p;
callParam.maxFrameRate = 30;
callParam.videoEncodeType = JVideoEncodeType.H264;

// 配置通话记录相关参数
callParam.autoRecord = true;
callParam.recordExtraInfo = "客户ID: 12345";

// 配置心跳参数
callParam.hbTime = 15;
callParam.hbTimeout = 45;

// 使用参数发起呼叫
JCCGuestManager.getInstance().call("10086", callParam, false);

Accessors

  • get autoRecord(): boolean

    获取是否自动录制通话

    Returns boolean

    是否自动录制

    返回当前是否配置为自动录制通话。

  • set autoRecord(value: boolean): void

    设置是否自动录制通话

    Parameters

    • value: boolean

      是否自动录制

    Returns void

    设置服务器是否自动录制此次通话。

    • true: 自动录制通话(默认值)
    • false: 不自动录制通话
  • get extraInfo(): string

    获取随路参数

    Returns string

    随路参数内容

    返回设置的随呼叫传递的额外信息。

  • set extraInfo(value: string): void

    设置随路参数

    Parameters

    • value: string

      随路参数内容

    Returns void

    设置随呼叫传递的额外信息,可用于传递自定义数据。 消息大小限制在2KB以内,超过部分将被截断。

  • get wholeRatio(): number

    获取通话视频全局宽高比

    Returns number

    宽高比值

    返回设置的通话视频宽高比。

  • set wholeRatio(value: number): void

    设置通话视频全局宽高比

    Parameters

    • value: number

      宽高比值

    Returns void

    设置通话中视频的宽高比,默认为16:9(约1.77777)。 此参数会影响SVC分辨率的计算。

  • get maxFrameRate(): number

    获取通话视频最大帧率

    Returns number

    最大帧率

    返回设置的通话视频最大帧率。

  • set maxFrameRate(value: number): void

    设置通话视频最大帧率

    Parameters

    • value: number

      最大帧率

    Returns void

    设置通话视频的最大帧率,有效范围为1-30,默认值为24。 帧率越高,视频越流畅,但需要更多的带宽和处理能力。

  • get maxResolution(): JResolution

    获取通话视频最大分辨率

    Returns JResolution

    最大分辨率

    返回设置的通话视频最大分辨率。

  • set maxResolution(value: JResolution): void

    设置通话视频最大分辨率

    Parameters

    • value: JResolution

      最大分辨率

    Returns void

    设置通话视频的最大分辨率,默认为720p。 分辨率越高,视频越清晰,但需要更多的带宽和处理能力。

    JResolution 分辨率定义

  • get svcResolution(): string

    获取SVC分辨率

    Returns string

    SVC分辨率参数

    返回设置的SVC分辨率参数。

  • set svcResolution(value: string): void

    设置SVC分辨率

    Parameters

    • value: string

      SVC分辨率参数

    Returns void

    设置可伸缩视频编码(SVC)的分辨率参数,用于自定义分层参数和码率。 默认值为"1 180 250 360 600 720 1400"。

    格式: 高度公约数 第一层高倍数 第一层码率 第二层高倍数 第二层码率 第三层高倍数 第三层码率 [第四层高倍数 第四层码率]

    例如 "1 180 250 360 600 720 1400" 表示:

    • 第一层: 分辨率宽320(180*16/9)高180; 码率250kbps
    • 第二层: 分辨率宽640(360*16/9)高360; 码率600kbps
    • 第三层: 分辨率宽1280(720*16/9)高720; 码率1400kbps
  • get videoDefinition(): JVideoDefinition

    获取视频清晰度

    Returns JVideoDefinition

    视频清晰度

    返回设置的视频清晰度。

  • set videoDefinition(value: JVideoDefinition): void

    设置视频清晰度

    Parameters

    • value: JVideoDefinition

      视频清晰度

    Returns void

    设置通话视频清晰度,主要通过修改SVC分辨率和最大帧率来调整清晰度。 默认为自定义(CUSTOM)模式。

    JVideoDefinition 视频清晰度定义

  • get hbTimeout(): number

    获取心跳超时时间

    Returns number

    超时时间(秒)

    返回设置的心跳超时时间。

  • set hbTimeout(value: number): void

    设置心跳超时时间

    Parameters

    • value: number

      超时时间(秒)

    Returns void

    设置心跳超时时间,默认为60秒。 服务器在该时间内未收到终端心跳包时,将自动结束该成员的通话。

  • get hbTime(): number

    获取心跳间隔时间

    Returns number

    间隔时间(秒)

    返回设置的心跳间隔时间。

  • set hbTime(value: number): void

    设置心跳间隔时间

    Parameters

    • value: number

      间隔时间(秒)

    Returns void

    设置心跳间隔时间,默认为20秒。 心跳间隔应小于心跳超时时间。终端会按此间隔向服务器发送心跳包。

  • get recordExtraInfo(): string

    获取录制扩展信息

    Returns string

    录制扩展信息

    返回设置的录制扩展信息。

  • set recordExtraInfo(value: string): void

    设置录制扩展信息

    Parameters

    • value: string

      录制扩展信息

    Returns void

    设置服务器录制的扩展信息,当自动录制开启时有效。 此信息将保存在录制的info文件中,可用于记录额外的业务数据。

  • get securityType(): JSecurityType

    获取媒体加密方式

    Returns JSecurityType

    加密方式

    返回设置的媒体加密方式。

  • set securityType(value: JSecurityType): void

    设置媒体加密方式

    Parameters

    • value: JSecurityType

      加密方式

    Returns void

    设置通话媒体数据加密方式,默认为SRTP加密。

    JSecurityType 加密方式定义

  • get videoEncodeType(): JVideoEncodeType

    获取视频编码类型

    Returns JVideoEncodeType

    视频编码类型

    返回设置的视频编码类型。

  • set videoEncodeType(value: JVideoEncodeType): void

    设置视频编码类型

    Parameters

    • value: JVideoEncodeType

      视频编码类型

    Returns void

    设置通话视频编码类型,默认为H.264编码。

    JVideoEncodeType 视频编码类型定义

  • get audioEncodeType(): JAudioEncodeType

    获取音频编码类型

    Returns JAudioEncodeType

    音频编码类型

    返回设置的音频编码类型。

  • set audioEncodeType(value: JAudioEncodeType): void

    设置音频编码类型

    Parameters

    • value: JAudioEncodeType

      音频编码类型

    Returns void

    设置通话音频编码类型,默认为OPUS编码。

    JAudioEncodeType 音频编码类型定义

  • get ratio(): number

    获取本端视频宽高比

    Returns number

    宽高比值

    返回设置的本端视频宽高比。

  • set ratio(value: number): void

    设置本端视频宽高比

    Parameters

    • value: number

      宽高比值

    Returns void

    设置本端视频的宽高比,默认为9/16(0.5625)。 将自己的视频采集根据宽高比裁剪后发送,不影响其他成员画面的显示比例。

  • get vipPower(): number

    获取访客呼叫权重

    Returns number

    权重值

    返回设置的访客呼叫权重。

  • set vipPower(value: number): void

    设置访客呼叫权重

    Parameters

    • value: number

      权重值(1-100)

    Returns void

    设置访客呼叫的优先级权重,取值范围为1-100,默认为0。 权重值越高,在排队中的优先级越高。 注意:此参数仅对普通呼叫有效,点对点呼叫和座席回呼时无效。

  • get channelId(): string

    获取渠道号

    Returns string

    渠道号

    返回设置的渠道号。

  • set channelId(value: string): void

    设置渠道号

    Parameters

    • value: string

      渠道号

    Returns void

    设置呼叫的渠道号,用于区分不同来源的呼叫。 目前此参数仅在呼叫指定业务时有效。

  • get localRecordFilePath(): string

    获取本地录制文件路径

    Returns string

    文件路径

    返回设置的本地录制文件路径。

  • set localRecordFilePath(value: string): void

    设置本地录制文件路径

    Parameters

    • value: string

      文件路径

    Returns void

    设置本地录制文件的保存路径,必须包含文件名(如xxx.mp4)。 默认存储在系统的/data/app/el2/100/base/应用包名/files/record目录下。

  • get captureResolutionType(): JResolution

    获取摄像头采集分辨率

    Returns JResolution

    采集分辨率

    返回设置的摄像头采集分辨率。

  • set captureResolutionType(value: JResolution): void

    设置摄像头采集分辨率

    Parameters

    • value: JResolution

      采集分辨率

    Returns void

    设置本地摄像头采集分辨率,默认为360p。 可选值:

    • JResolution.RESOLUTION_360p (640x360)
    • JResolution.RESOLUTION_720p (1280x720)
    • JResolution.RESOLUTION_1080p (1920x1080)

    JResolution 分辨率定义

  • get captureFrameRate(): number

    获取摄像头采集帧率

    Returns number

    采集帧率

    返回设置的摄像头采集帧率。

  • set captureFrameRate(value: number): void

    设置摄像头采集帧率

    Parameters

    • value: number

      采集帧率

    Returns void

    设置本地摄像头采集帧率,默认为24帧/秒。

  • get traceId(): string

    获取日志跟踪ID

    Returns string

    跟踪ID

    返回设置的日志跟踪ID。

  • set traceId(value: string): void

    设置日志跟踪ID

    Parameters

    • value: string

      跟踪ID

    Returns void

    设置用于日志跟踪的唯一标识符,可选。 方便在日志中追踪特定呼叫的所有相关记录。

  • get serialId(): string

    获取业务流水号

    Returns string

    业务流水号

    返回设置的业务流水号。

  • set serialId(value: string): void

    设置业务流水号

    Parameters

    • value: string

      业务流水号

    Returns void

    设置呼叫的业务流水号,应保证唯一性,可选。 用于在业务系统中标识和追踪此次呼叫。

  • get extraSerialId(): string

    获取外部自定义业务流水号

    Returns string

    外部业务流水号

    返回设置的外部自定义业务流水号。

  • set extraSerialId(value: string): void

    设置外部自定义业务流水号

    Parameters

    • value: string

      外部业务流水号

    Returns void

    设置外部系统的自定义业务流水号,可选。 用于与外部系统的数据关联。