config(配置)
接口描述
配置OpenEyeCall的运行参数。
注意事项
已经建立与OpenEyeCall的WebSocket连接。
方法定义
TUPCall.prototype.config = function(params, callbacks)
参数描述
参数名 |
类型 |
可选/必选 |
描述 |
|---|---|---|---|
log_path |
String |
可选 |
SIP消息日志存放路径。绝对路径或OpenEye安装目录的相对路径。 例如：“C:/log”，"./log"。 也可以使用"D:\\tup\\log"。 如果路径不存在，则会自动创建。 如果使用绝对路径，需确保各客户端均有指定的盘符，因而建议使用相对路径。 |
call |
必选 |
呼叫业务。 |
|
network |
必选 |
网络配置。 |
|
media |
必选 |
媒体设置。 |
|
audio |
必选 |
音频设置。 |
|
account |
必选 |
账号密码类型设置。 |
参数名 |
类型 |
可选/必选 |
描述 |
|---|---|---|---|
serverAddr |
String |
必选 |
SIP服务器IP地址 |
sipServerPort |
Number |
必选 |
SIP服务器端口，UDP默认5060，默认TLS端口5061。 |
sipTransportMode |
Number |
必选 |
sip信令传输模式，0为UDP，1为TLS。 |
httpPort |
Number |
必选 |
一般为0。 |
参数名 |
类型 |
可选/必选 |
描述 |
|---|---|---|---|
user_type |
Number |
必选 |
用户端类型。 设置为0。 |
tls_anonymous_enable |
Number |
必选 |
TLS匿名认证模式。0-不开启，1-开启
说明：
匿名认证，存在安全风险，请谨慎开启。默认不开启。 |
tls_rootcertpath |
String |
可选 |
根证书完整路径。使用TLS传输时需要配置根证书。 例："F:/test/cert/root_cert_huawei.pem" |
trans_mode |
Number |
必选 |
SIP传输协议。
|
参数名 |
类型 |
可选/必选 |
描述 |
|---|---|---|---|
trans_mode |
Number |
必选 |
媒体流加密模式。 设置为1 ，表示支持RTP（不加密）和SRTP（加密）。
说明：
RTP（不加密），存在安全风险，请谨慎使用。 |
参数名 |
类型 |
可选/必选 |
描述 |
|---|---|---|---|
audio_codec |
String |
必选 |
音频编解码优先级，以及支持的音频编解码方式。例如："112,98,18,9,8,0"。
|
dtmf_mode |
Number |
可选 |
DTMF (Dual Tone Multi Frequency) 模式，即按键声音和数据的传输模式。
|
audio_anr |
Number |
可选 |
噪音抑制。取值范围0-4,0表示关闭，1-4数值越大，噪音抑制强度越大，默认关闭。 |
audio_aec |
Number |
可选 |
回声消除，0关闭，1开启，默认关闭，建议开启。 |
audio_agc |
Number |
可选 |
自动增益，0关闭，1开启，默认关闭。 |
参数名 |
类型 |
描述 |
|---|---|---|
description |
String |
当前请求描述。 |
local_ip |
String |
本地IP地址。 IPv4格式。如: "192.168.10.100" |
result |
Number |
查询结果。0表示成功，其他表示失败。 |
rsp |
Number |
内部消息编号。 |
使用示例
function sipBasicCfg() {
global_cloudIPCC_SDK.tupCall.config({
networkInfo: {
serverAddr: "example.com",
sipServerPort: 5060,
sipTransportMode: "10.175.1.61",
httpPort: 5060
}
},{response: configResponse});
}
function configResponse(data) {
if (data.result == 0) {
console.info("Config Success");
} else {
console.error("Config Failed");
console.error(data);
}
}
