查询常规设置
获取系统的常规设置。
请求 URL
GET {base_url}/{api_path}/preference/get?access_token={access_token}请求参数
无请求参数。直接发送请求 URL 查询常规设置。
响应参数
| 参数 | 类型 | 说明 |
|---|---|---|
| errcode | Integer | 返回错误码。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
|
| errmsg | String | 返回信息。
|
| data | Object<Preference> | 系统的常规设置。 |
- Preference
-
参数 类型 说明 基本 dev_name String 设备名称。 disp_dev_name String 设备的显示名称。 name_disp_fmt String 名称显示格式。 first_last：名字在前、姓氏在后，中间以空格分隔last_first：姓氏在前、名字在后，中间以空格分隔lastfirst：姓氏在前、名字在后，中间无空格
max_call_duration Integer 单通通话的最大时长。 注：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 信号的长度，单位毫秒。 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 自定义状态的显示名称。 position Integer 自定义状态的排序位置。 display_changed Integer 自定义状态是否已更改。 0：禁用。1：启用。
origin_presence String 原始状态。
示例
请求示例
GET /openapi/v1.0/preference/get?access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1
Host: yeastardocs.example.yeastarcloud.com响应示例
HTTP/1.1 200 OK
{
"errcode": 0,
"errmsg": "SUCCESS",
"data": {
"dev_name": "PBX",
"disp_dev_name": "PBX",
"name_disp_fmt": "first_last",
"max_call_duration": 10800,
"tone_region": "us",
"enb_dtmf_passthrough": 0,
"dtmf_duration": 120,
"dtmf_gap": 120,
"enb_match_route": 0,
"ext_start": "1000",
"ext_end": "5999",
"parking_start": "6000",
"parking_end": "6099",
"vm_group_start": "6100",
"vm_group_end": "6199",
"ivr_start": "6200",
"ivr_end": "6299",
"ring_group_start": "6300",
"ring_group_end": "6399",
"queue_start": "6400",
"queue_end": "6499",
"conference_start": "6500",
"conference_end": "6599",
"paging_start": "6600",
"paging_end": "6699",
"account_start": "6700",
"account_end": "6799",
"enb_cid_name_by_call_features": 1,
"enb_cid_name_by_trunk_did": 1,
"enb_organization_status": 0,
"company_name": "ys",
"webrtc_trunk_start": "6800",
"webrtc_trunk_end": "6899",
"allow_im": 1,
"enb_through_api": 0,
"enb_through_speed_dial": 0,
"enb_through_click2call": 0,
"enb_incoming_calls": 0,
"enb_call_note": 1,
"enb_call_note_queue": 1,
"enb_call_note_ring_group": 1,
"enb_call_note_vm": 1,
"enb_call_note_ext": 1,
"enb_call_note_outbound": 1,
"cfd_start": "6900",
"cfd_end": "6999",
"presence_list": [
{
"position": 1,
"display_icon": 1,
"display_name": "available",
"display_changed": 0,
"origin_presence": "available"
},
{
"position": 2,
"display_icon": 2,
"display_name": "away",
"display_changed": 0,
"origin_presence": "away"
},
{
"position": 3,
"display_icon": 3,
"display_name": "business_trip",
"display_changed": 0,
"origin_presence": "business_trip"
},
{
"position": 4,
"display_icon": 4,
"display_name": "do_not_disturb",
"display_changed": 0,
"origin_presence": "do_not_disturb"
},
{
"position": 5,
"display_icon": 5,
"display_name": "launch",
"display_changed": 0,
"origin_presence": "launch"
},
{
"position": 6,
"display_icon": 6,
"display_name": "off_work",
"display_changed": 0,
"origin_presence": "off_work"
}
],
"enb_number_filter": 1,
"caller_id_display_rule_desktop": 2,
"caller_id_display_rule_mobile": 1,
"ai_receptionist_start": "7000",
"ai_receptionist_end": "7099",
"enb_diversion_for_ext_forwarding": 0,
"enb_message_read_receipt": 0
}
}