Edit Preference Setting
Update the system preference settings.
Request URL
POST {base_url}/{api_path}/preference/update?access_token={access_token}Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| Basic | |||
| dev_name | No | String | The device name. |
| name_disp_fmt | No | String | The name display format. Valid value:
|
| max_call_duration | No | Integer | The maximum call duration for an active call, in seconds. Valid value:
0-9999999, where |
| tone_region | No | String | The country or region whose default dial tone, busy tone, and ring tone are used. Note: For valid values, see Supported Values for Tone
Region.
|
| fxo_mode | No | String | The FXO mode. Valid value:
|
| flash_event | No | String | The event triggered when the hook flash is pressed. Valid value:
|
| enb_ring_back | No | Integer | Whether to allow callers to hear the virtual ringback tone before the callee
answers when making outbound calls through a cellular trunk. Valid value:
|
| Organization Management | |||
| enb_organization_status | No | Integer | Whether to organize extension users into organizations. Valid value:
|
| company_name | No | String | The company name, which is used as the root organization name. |
| Internal Chat | |||
| allow_im | No | Integer | Whether to enable internal chat. Valid value:
|
| Read Receipt | |||
| enb_message_read_receipt | No | Integer | Whether to allow agents and customers to see a read status indicator ( ) beside their
messages in external chats conducted via online messaging channels (WhatsApp,
Facebook, and Live Chat).Valid value:
|
| Caller ID Name | |||
| caller_id_display_rule_desktop | No | Integer | The display rule for Caller ID Name on Linkus Web Client, Linkus Desktop
Client, and extension endpoints (e.g. IP phones and softphones). Valid value:
|
| caller_id_display_rule_mobile | No | Integer | The display rule for Caller ID Name on Linkus Mobile Client. Valid value:
|
| Distinctive Caller ID Name | |||
| enb_cid_name_by_call_features | No | Integer | Whether to display the originated name when users receive calls from a ring
group, queue, IVR, or call flow. Valid value:
|
| enb_cid_name_by_trunk_did | No | Integer | Whether to display the DID name associated with the source trunk. Valid value:
|
| enb_diversion_for_ext_forwarding | No | Integer | Whether to display the name and number of the forwarding extension when an
incoming call to an extension is forwarded directly to the destination configured
for Extension Forwarding with Diversion SIP
Header. Valid value:
|
| Masked Number | |||
| enb_through_api | No | Integer | Whether to mask the destination number when a third-party application initiates
an outbound call through the API. Valid value:
|
| enb_through_speed_dial | No | Integer | Whether to mask the destination number when an extension user makes an outbound
call using Speed Dial. Valid value:
|
| enb_through_click2call | No | Integer | Whether to mask the destination number when an extension user initiates a call
via click-to-call using 'Yeastar Linkus for Google' Chrome extension. Valid value:
|
| enb_incoming_calls | No | Integer | Whether to mask external phone numbers when extension users receiving inbound
calls. Valid value:
|
| Call Notes | |||
| enb_call_note | No | Integer | Whether to enable call note. Valid value:
|
| enb_call_note_queue | No | Integer | Whether queue agents can add tags and
remarks during queue calls or wrap-up time, and review or edit call notes in the
corresponding call logs. Valid value:
|
| enb_call_note_ring_group | No | Integer | Whether ring group members can add tags and remarks during ring group calls,
and review or edit call notes in the corresponding call logs. Valid value:
|
| enb_call_note_vm | No | Integer | Whether extension users can add tags and remarks to the calls sent to their
extension's voicemails, and review or edit call notes in the corresponding call
log. Valid value:
|
| enb_call_note_ext | No | Integer | Whether extension users can add tags and remarks during calls they receive, and
review or edit call notes in the corresponding call logs. Valid value:
|
| enb_call_note_outbound | No | Integer | Whether extension users can add tags and remarks during outbound calls they
initiate, and review or edit call notes in the corresponding call logs. Valid value:
|
| Presence | |||
| presence_list | No | Array<Presence> | The list of custom presence statuses. |
| Filter Number | |||
| enb_number_filter | No | Integer | Whether to automatically remove all special characters (except digits,
+, *, and #) from dialed
numbers before sending them to the trunk.Valid value:
|
| DTMF | |||
| enb_dtmf_passthrough | No | Integer | Whether PBX passes DTMF tones directly to the other party without processing
them. Valid value:
|
| dtmf_duration | No | Integer | The duration (in millisecond) of DTMF audio signal sent by the PBX. Valid value: 80 - 300 |
| dtmf_gap | No | Integer | The interval (in millisecond) between consecutive DTMF audio signals sent by the PBX. |
| Extension Preferences | |||
| ext_start | No | String | The start of the extension number range. |
| ext_end | No | String | The end of the extension number range. |
| parking_start | No | String | The start of the parking lot number range. |
| parking_end | No | String | The end of the parking lot number range. |
| vm_group_start | No | String | The start of the group voicemail number range. |
| vm_group_end | No | String | The end of the group voicemail number range. |
| ivr_start | No | String | The start of the IVR number range. |
| ivr_end | No | String | The end of the IVR number range. |
| ring_group_start | No | String | The start of the ring group number range. |
| ring_group_end | No | String | The end of the ring group number range. |
| queue_start | No | String | The start of the queue number range. |
| queue_end | No | String | The end of the queue number range. |
| conference_start | No | String | The start of the conference number range. |
| conference_end | No | String | The end of the conference number range. |
| paging_start | No | String | The start of the paging group number range. |
| paging_end | No | String | The end of the paging group number range. |
| account_start | No | String | The start of the account trunk number range. |
| account_end | No | String | The end of the account trunk number range. |
| webrtc_trunk_start | No | String | The start of the WebRTC trunk number range. |
| webrtc_trunk_end | No | String | The end of the WebRTC trunk number range. |
| cfd_start | No | String | The start of the call flow number range. |
| cfd_end | No | String | The end of the call flow number range. |
- Presence
-
Parameter Type Description display_icon Integer The icon representing the custom status. Valid value:
1: Available.2: Away.3: Business Trip.4: Do Not Disturb.5: Lunch.6: Off Work.
display_name String The display name of the custom status.
Response parameters
| Parameter | Type | Description |
|---|---|---|
| errcode | Integer | Returned error code.
Note: You can check the error code and
error message in Error Code and Error Message.
|
| errmsg | String | Returned message.
|
Example
Request example
POST /openapi/v1.0/preference/update?access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1
Host: 192.168.5.150:8088
Content-Type: application/json
{
"dtmf_duration": 100
}Response example
HTTP/1.1 200 OK
{
"errcode": 0,
"errmsg": "SUCCESS",
"submsg": ""
}