本文为您介绍了Web SDK的功能说明以及错误码描述。

SDK DEMO使用

  • VoIP Web SDK的Demo项目已开源至Github社区,您可通过Demo演示快速进入开发,VoIP Web Demo
  • AK和SK即AccessKey ID和AccessKeySecret是您访问阿里云API的密钥对,可以在密钥管理平台管理查看。
  • 账号可以由服务端接口AddRtcAccount(对应Module字段),也可单击OpenAPI生成DeviceId随便填生成的数据中Module即为账号。

功能使用

  • 设置默认的呼叫超时时间。
    rtc.setDefaultCallTimeout(seconds)
    说明 seconds number类型,呼叫超时时间,单位为秒,限制在30秒~90秒之间;小于30按30算,大于90按90算。
  • 是否允许日志上传,默认不上传。
    /**
     * 是否允许日志上传,默认不上传
     * @param enable true 上传日志  false 不上传
     */
    setUploadEnable(enable)
    说明
    • 为排查问题方便,建议设置为true。
    • 此接口适用版本1.7.0及以上。
  • 可选:开启服务端录音。
    pstnCall.setServerRecordEnabled(true)
  • 可选:本地禁音。
    pstnCall.muteLocalAudio()
  • 可选:本地取消禁音。
    pstnCall.unmuteLocalAudio()
  • 发送dtmf。
    pstnCall.sendDtmfData(dtmf)
    说明 只能是0-9、*、#组成的字符串,最大长度不超过32位。
  • 获取当前通话的ChannelId。
    当通话遇到问题时提供ChannelId,可以用来查当前通话的日志埋点。
    getChannelId(): string

错误码

错误码 数值 原因
ERROR_MQTT_CONNECT_FAIL 1000100 mqtt连接失败。
ERROR_UPLOAD_TOKEN_FAIL 1000104 token上传失败。
ERROR_LOCAL_STOP 2000000 本地主动挂断。
ERROR_REMOTE_HANGUP 2000099 对端主动挂断。
ERROR_CALL_SELF 2000100 拨打自己。
ERROR_CALL_EMPTY 2000101 拨打电话为空。
ERROR_CALLEE_ALERTING_TIMEOUT 2000103 被叫时,振铃超时。
ERROR_REMOTE_REFUSE 2000106 主叫时,对端拒绝应答。
ERROR_REMOTE_CANCEL 2000107 被叫时,对端取消呼叫。
ERROR_NO_ANSWER 2000108 被叫无人接听。
ERROR_SERVICE_UNAVAILABLE 2000113 AlicomRTC服务不可用。
ERROR_LOCAL_DESTROY 2000116 本地主动销毁服务。
ERROR_TIME_OUT 2000102 joinChannel超时。
ERROR_NETWORK_INVALID 2000121 网络异常。
ERROR_MICROPHONE_NO_PERMISSION 2000130 麦克风无权限。
ERROR_MICROPHONE_NO_DEVICE 2000135 没有麦克风设备。
ERROR_MICROPHONE_NOT_ALLOWED 2000136 浏览器不允许使用麦克风。
ERROR_MICROPHONE_NOT_READABLE 2000137 系统禁用麦克风或者麦克风被占用。
ERROR_SERVER_BASE 3000000 服务端返回业务异常的错误基准。
ERROR_SERVER_KICKED 3110000 账号被登录或被踢。
ERROR_SERVER_UNAVAILABLE 3110001 服务异常。
ERROR_MEDIA_BASE 4000000 媒体SDK返回异常的错误基准。