Class JCallExtraParam

通话额外参数类 JCallExtraParam

Remarks

用于在发起通话邀请时配置通话的各种额外参数以及收到通话邀请时的各种参数信息，包括是否使用视频、通话标识信息、用户信息以及SIP参数等。 这些参数会影响通话的建立方式和相关展示信息。

Example

const extraParam = new JCallExtraParam();
extraParam.video = true;
extraParam.callerDisplayName = "张三";
extraParam.calleeDisplayName = "李四";
callManager.invite("user123", extraParam);

Accessors

video serialId callerUserId callerDisplayName calleeUserId calleeDisplayName calleeUserType callerNumberForSip routeId extraInfo

Accessors

video

  • get video(): boolean

    获取是否视频通话

    Returns boolean

    是否使用视频模式，默认为true

  • set video(value: boolean): void

    设置是否视频通话

    Parameters

    • value: boolean

      是否使用视频模式

    Returns void

    Remarks

    设置通话是否包含视频，true表示视频通话，false表示音频通话

serialId

  • get serialId(): string

    获取业务流水号

    Returns string

    通话业务流水号

  • set serialId(value: undefined | string): void

    设置业务流水号

    Parameters

    • value: undefined | string

      通话业务流水号

    Returns void

    Remarks

    设置唯一标识该通话的业务流水号，用于跟踪通话记录和关联业务系统

callerUserId

  • get callerUserId(): undefined | string

    获取邀请者用户ID

    Returns undefined | string

    邀请者用户ID

  • set callerUserId(value: undefined | string): void

    设置邀请者用户ID

    Parameters

    • value: undefined | string

      邀请者用户ID

    Returns void

    Remarks

    设置发起通话邀请的用户ID

callerDisplayName

  • get callerDisplayName(): undefined | string

    获取邀请者用户昵称

    Returns undefined | string

    邀请者用户昵称

  • set callerDisplayName(value: undefined | string): void

    设置邀请者用户昵称

    Parameters

    • value: undefined | string

      邀请者用户昵称

    Returns void

    Remarks

    设置发起通话邀请的用户昵称，用于在通话界面显示

calleeUserId

  • get calleeUserId(): undefined | string

    获取被邀请者用户ID

    Returns undefined | string

    被邀请者用户ID

  • set calleeUserId(value: undefined | string): void

    设置被邀请者用户ID

    Parameters

    • value: undefined | string

      被邀请者用户ID

    Returns void

    Remarks

    设置接收通话邀请的用户ID

calleeDisplayName

  • get calleeDisplayName(): undefined | string

    获取被邀请者用户昵称

    Returns undefined | string

    被邀请者用户昵称

  • set calleeDisplayName(value: undefined | string): void

    设置被邀请者用户昵称

    Parameters

    • value: undefined | string

      被邀请者用户昵称

    Returns void

    Remarks

    设置接收通话邀请的用户昵称，用于在通话界面显示

calleeUserType

  • get calleeUserType(): JCallUserType

    获取被邀请者用户类型

    Returns JCallUserType

    被邀请者用户类型，默认为 JCallUserType.APP

  • set calleeUserType(value: JCallUserType): void

    设置被邀请者用户类型

    Parameters

    • value: JCallUserType

      被邀请者用户类型

    Returns void

    Remarks

    设置接收通话邀请的用户类型，可以是APP用户或SIP用户。 当被邀请者用户ID不为空时，该值才有效。

    See

    • JCallUserType.APP APP用户
    • JCallUserType.SIP SIP用户

callerNumberForSip

  • get callerNumberForSip(): undefined | string

    获取SIP外呼主叫号码

    Returns undefined | string

    SIP外呼主叫号码

  • set callerNumberForSip(value: undefined | string): void

    设置SIP外呼主叫号码

    Parameters

    • value: undefined | string

      SIP外呼主叫号码

    Returns void

    Remarks

    当被邀请者用户类型是SIP用户时，该参数有效。 设置SIP外呼时显示的主叫号码。

routeId

  • get routeId(): undefined | string

    获取SIP外呼线路ID

    Returns undefined | string

    SIP外呼线路ID

  • set routeId(value: undefined | string): void

    设置SIP外呼线路ID

    Parameters

    • value: undefined | string

      SIP外呼线路ID

    Returns void

    Remarks

    当被邀请者用户类型是SIP用户时，该参数有效。 设置SIP外呼使用的线路ID。

extraInfo

  • get extraInfo(): any

    获取随路参数

    Returns any

    随路参数

  • set extraInfo(value: any): void

    设置随路参数

    Parameters

    • value: any

      随路参数

    Returns void

    Remarks

    设置通话邀请时的附加信息，可用于传递业务相关的自定义数据

设置

主题