编辑常规设置

更新系统的常规设置。

请求 URL

POST {base_url}/{api_path}/preference/update?access_token={access_token}

请求参数

参数 是否必填 类型 说明
基本
dev_name 否 String 设备名称。
name_disp_fmt 否 String 名称显示格式。

取值范围：

  • first_last：名字在前、姓氏在后，中间以空格分隔
  • last_first：姓氏在前、名字在后，中间以空格分隔
  • lastfirst：姓氏在前、名字在后，中间无空格
max_call_duration 否 Integer 单通通话的最大通话时长，单位为秒。

取值范围：0 - 9999999，其中 0 表示无限制。
tone_region 否 String 用于启用默认拨号音、忙音和回铃音的国家或地区。
注： 取值范围请参见 信号音取值范围。
组织管理
enb_organization_status 否 Integer 是否启用组织管理功能。

取值范围：

  • 0：禁用。
  • 1：启用。
company_name 否 String 公司名称，用作根组织名称。
内部聊天
allow_im 否 Integer 是否启用内部聊天。

取值范围：

  • 0：禁用。
  • 1：启用。
已读回执
enb_message_read_receipt 否 Integer 是否允许客服和客户在通过在线消息渠道（WhatsApp、Facebook 和 Live Chat）进行的外部会话中，在消息旁查看已读状态标识（）。

取值范围：

  • 0：禁用。
  • 1：启用。
来电显示名称
caller_id_display_rule_desktop 否 Integer Linkus 网页端、Linkus 桌面端和分机终端 (如 IP 话机和软电话) 来电显示名称的显示规则。
  • 0：同时显示联系人名称和主叫携带的来电显示名称
  • 1：仅显示联系人名称。
  • 2：显示主叫携带的来电显示名称。如果主叫仅发送号码，则显示匹配的联系人名称。
caller_id_display_rule_mobile 否 Integer Linkus 移动端上来电显示名称的显示规则。

取值范围：

  • 0：同时显示本地联系人名称和 SIP 消息 From 头中携带的名称。
  • 1：仅显示本地联系人名称。
  • 2：显示 SIP 消息 From 头中携带的名称。如果该名称为号码，则显示本地联系人名称。
特色来电显示名称
enb_cid_name_by_call_features 否 Integer 用户收到来自响铃组、队列、IVR 或通话流程的来电时，来电显示是否显示发起方的名称。

取值范围：

  • 0：禁用。
  • 1：启用。
enb_cid_name_by_trunk_did 否 Integer 来电显示是否显示来源中继的 DID 名称。

取值范围：

  • 0：禁用。
  • 1：启用。
enb_diversion_for_ext_forwarding 否 Integer 当分机的来电被直接转接到 带有 Diversion SIP 头的分机转接 所配置的目的地类型时，来电显示是否显示发起转接的分机名称和号码。

取值范围：

  • 0: 不显示。
  • 1: 显示。
号码加密
enb_through_api 否 Integer 第三方应用通过 API 发起外呼时，是否对被叫号码进行加密。

取值范围：

  • 0：禁用。
  • 1：启用。
enb_through_speed_dial 否 Integer 分机用户通过速拨码发起外呼时，是否对被叫号码进行加密。

取值范围：

  • 0：禁用。
  • 1：启用。
enb_through_click2call 否 Integer 分机用户通过 'Yeastar Linkus for Google' 谷歌插件的点击呼叫功能发起通话时，是否对被叫号码进行加密。

取值范围：

  • 0：禁用。
  • 1：启用。
enb_incoming_calls 否 Integer 分机用户收到来电时，是否对外部号码进行加密。

取值范围：

  • 0：禁用。
  • 1：启用。
通话备注
enb_call_note 否 Integer 是否启用通话备注功能。

取值范围：

  • 0：禁用。
  • 1：启用。
enb_call_note_queue 否 Integer 是否允许队列坐席在通话过程中或休息时间内使用通话备注功能添加标签和备注，并在相应通话记录中查看或编辑通话备注。

取值范围：

  • 0：禁用。
  • 1：启用。
enb_call_note_ring_group 否 Integer 是否允许响铃组成员在通话过程中使用通话备注功能添加标签和备注，并在相应通话记录中查看或编辑通话备注。

取值范围：

  • 0：禁用。
  • 1：启用。
enb_call_note_vm 否 Integer 是否允许分机用户使用通话备注功能为转入其分机语音信箱的通话添加标签和备注，并在相应通话记录中查看或编辑通话备注。

取值范围：

  • 0：禁用。
  • 1：启用。
enb_call_note_ext 否 Integer 是否允许分机用户在通话过程中使用通话备注功能添加标签和备注，并在相应通话记录中查看或编辑通话备注。

取值范围：

  • 0：禁用。
  • 1：启用。
enb_call_note_outbound 否 Integer 是否允许分机用户在呼出通话过程中使用通话备注功能添加标签和备注，并在相应通话记录中查看或编辑通话备注。

取值范围：

  • 0：禁用。
  • 1：启用。
在线状态
presence_list 否 Array<Presence> 自定义状态列表。
号码过滤
enb_number_filter 否 Integer 将被叫号码发送到中继之前，系统是否自动移除号码中的所有特殊字符 (数字、+、* 和 # 除外)。

取值范围：

  • 0：禁用。
  • 1：启用。
DTMF
enb_dtmf_passthrough 否 Integer 是否直接将 DTMF 的双频音作为话音编码压缩，传递给通话另一方。

取值范围：

  • 0：禁用。
  • 1：启用。
dtmf_duration 否 Integer PBX 发送的 DTMF 信号的长度，单位毫秒。

取值范围：80 - 300
dtmf_gap 否 Integer PBX 发送的 DTMF 信号的间隔，单位毫秒。
分机偏好设置
ext_start 否 String 分机号码范围的起始值。
ext_end 否 String 分机号码范围的结束值。
parking_start 否 String 停泊号码范围的起始值。
parking_end 否 String 停泊号码范围的结束值。
vm_group_start 否 String 群语音信箱号码范围的起始值。
vm_group_end 否 String 群语音信箱号码范围的结束值。
ivr_start 否 String IVR 号码范围的起始值。
ivr_end 否 String IVR 号码范围的结束值。
ring_group_start 否 String 响铃组号码范围的起始值。
ring_group_end 否 String 响铃组号码范围的结束值。
queue_start 否 String 队列号码范围的起始值。
queue_end 否 String 队列号码范围的结束值。
conference_start 否 String 会议号码范围的起始值。
conference_end 否 String 会议号码范围的结束值。
paging_start 否 String 广播组号码范围的起始值。
paging_end 否 String 广播组号码范围的结束值。
account_start 否 String 账号中继号码范围的起始值。
account_end 否 String 账号中继号码范围的结束值。
webrtc_trunk_start 否 String WebRTC 中继号码范围的起始值。
webrtc_trunk_end 否 String WebRTC 中继号码范围的结束值。
cfd_start 否 String 通话流程号码范围的起始值。
cfd_end 否 String 通话流程号码范围的结束值。
ai_receptionist_start 否 String AI 接待员号码范围的起始值。
ai_receptionist_end 否 String AI 接待员号码范围的结束值。
Presence
参数 类型 说明
display_icon Integer 自定义状态的图标。

取值范围：

  • 1：空闲。
  • 2：离开。
  • 3：出差。
  • 4：免打扰。
  • 5：午休。
  • 6：下班。
display_name String 自定义状态的显示名称。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。

示例

请求示例

POST /openapi/v1.0/preference/update?access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
  "dtmf_duration": 100
}

响应示例

HTTP/1.1 200 OK
{
  "errcode": 0,
  "errmsg": "SUCCESS",
  "submsg": ""
}