Query Preference Setting

Query the system's preference settings.

Request URL

GET {base_url}/{api_path}/preference/get?access_token={access_token}

Request parameters

No request parameters. Send the request URL directly to query preference setting.

Response parameters

Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
data Object<Preference> The system's preference settings.
Preference
Parameter Type Description
Basic
dev_name String The device name.
disp_dev_name String The display name of the device.
name_disp_fmt String The name display format.
  • first_last: First Name Last Name with Space Inbetween
  • last_first: Last Name First Name with Space Inbetween
  • lastfirst: Last Name First Name without Space Inbetween
max_call_duration Integer The maximum duration of an active call, in seconds.
Note: 0 indicates no limit.
tone_region String

The country or region used to determine the default dial tone, busy tone, and ring tone.
fxo_mode String The FXO mode.
  • FCC: FCC (United States).
  • TBR21: TBR21 (Europe).
  • ARGENTINA: Argentina.
  • AUSTRALIA: Australia.
  • AUSTRIA: Austria.
  • BAHRAIN: Bahrain.
  • BELGIUM: Belgium.
  • BRAZIL: Brazil.
  • BULGARIA: Bulgaria.
  • CANADA: Canada.
  • CHILE: Chile.
  • CHINA: China.
  • COLUMBIA: Colombia.
  • CROATIA: Croatia.
  • CYRPUS: Cyprus.
  • CZECH: Czech.
  • DENMARK: Denmark.
  • ECUADOR: Ecuador.
  • EGYPT: Egypt.
  • ELSALVADOR: El Salvador.
  • FINLAND: Finland.
  • FRANCE: France.
  • GERMANY: Germany.
  • GREECE: Greece.
  • GUAM: Guam.
  • HONGKONG: Hong Kong, China.
  • HUNGARY: Hungary.
  • ICELAND: Iceland.
  • INDIA: India.
  • INDONESIA: Indonesia.
  • IRELAND: Ireland.
  • ISRAEL: Israel.
  • ITALY: Italy.
  • JAPAN: Japan.
  • JORDAN: Jordan.
  • KAZAKHSTAN: Kazakhstan.
  • KUWAIT: Kuwait.
  • LATVIA: Latvia.
  • LEBANON: Lebanon.
  • LUXEMBOURG: Luxembourg.
  • MACAO: Macao, China.
  • MALAYSIA: Malaysia.
  • MALTA: Malta.
  • MEXICO: Mexico.
  • MOROCCO: Morocco.
  • NETHERLANDS: Netherlands.
  • NEWZEALAND: New Zealand.
  • NIGERIA: Nigeria.
  • NORWAY: Norway.
  • OMAN: Oman.
  • PAKISTAN: Pakistan.
  • PERU: Peru.
  • PHILIPPINES: Philippines.
  • POLAND: Poland.
  • PORTUGAL: Portugal.
  • ROMANIA: Romania.
  • RUSSIA: Russia.
  • SAUDIARABIA: Saudi Arabia.
  • SINGAPORE: Singapore.
  • SLOVAKIA: Slovakia.
  • SLOVENIA: Slovenia.
  • SOUTHAFRICA: South Africa.
  • SOUTHKOREA: South Korea.
  • SPAIN: Spain.
  • SWEDEN: Sweden.
  • SWITZERLAND: Switzerland.
  • SYRIA: Syria.
  • TAIWAN: Taiwan, China.
  • THAILAND: Thailand.
  • TURKEY: Turkey.
  • UAE: United Arab Emirates.
  • UK: United Kingdom.
  • USA: United States.
  • YEMEN: Yemen.
flash_event String The event triggered when the hook flash is pressed.
  • threewaycall: 3-way calling.
  • tranfer: Call transfer.
enb_ring_back Integer

Whether the system plays a virtual ringback tone to the caller before the callee answers when the call is made through a cellular trunk.

  • 0: Disabled.
  • 1: Enabled.
Organization Management
enb_organization_status Integer Whether extension users are organized into organizations.
  • 0: Disabled.
  • 1: Enabled.
company_name String The company name used as the root organization name.
Internal Chat
allow_im Integer Whether internal chat is enabled.
  • 0: Disabled.
  • 1: Enabled.
Read Receipt
enb_message_read_receipt Integer

Whether a read status indicator () is displayed beside messages in external chats conducted via online messaging channels (WhatsApp, Facebook, and Live Chat).

  • 0: Disabled.
  • 1: Enabled.
Caller ID Name
caller_id_display_rule_desktop Integer The display rule for Caller ID Name on Linkus Web Client, Linkus Desktop Client, and extension endpoints (e.g. IP phones and softphones).
  • 0: Display both the contact name and the caller ID name carried by the caller
  • 1: Display only the contact name.
  • 2: Display the caller ID name carried by the caller. If the caller only send a number, display the matched contact name instead.
caller_id_display_rule_mobile Integer The display rule for Caller ID Name on Linkus Mobile Client.
  • 0: Display both the local contact name and the name carried in the From header of the SIP message.
  • 1: Display only the local contact name.
  • 2: Display the name carried in the From header of the SIP message. If it is a number, display the local contact name instead.
Distinctive Caller ID Name
enb_cid_name_by_call_features Integer Whether the Caller ID displays the originated name when users receive a call from a ring group, queue, IVR, or call flow.
  • 0: Disabled.
  • 1: Enabled.
enb_cid_name_by_trunk_did Integer Whether the Caller ID displays the DID name of the source trunk.
  • 0: Disabled.
  • 1: Enabled.
enb_diversion_for_ext_forwarding Integer Whether the Caller ID displays the name and number of the extension from which the call was forwarded when an incoming call to an extension is forwarded directly to a destination configured for Extension Forwarding with Diversion SIP Header.
  • 0: Not displayed.
  • 1: Displayed.
Masked Number
enb_through_api Integer Whether destination number is masked when a third-party application initiates external calls through the API interface.
  • 0: Disabled.
  • 1: Enabled.
enb_through_speed_dial Integer Whether destination number is masked when extension users make external calls through Speed Dial.
  • 0: Disabled.
  • 1: Enabled.
enb_through_click2call Integer Whether destination number is masked when extension users initiate calls via click-to-call using 'Yeastar Linkus for Google' Chrome extension.
  • 0: Disabled.
  • 1: Enabled.
enb_incoming_calls Integer Whether external numbers are masked when extension users receiving inbound calls.
  • 0: Disabled.
  • 1: Enabled.
Call Notes
enb_call_note Integer Whether call note is enabled.
  • 0: Disabled.
  • 1: Enabled.
enb_call_note_queue 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.
  • 0: Disabled.
  • 1: Enabled.
enb_call_note_ring_group 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.
  • 0: Disabled.
  • 1: Enabled.
enb_call_note_vm 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.
  • 0: Disabled.
  • 1: Enabled.
enb_call_note_ext Integer Whether extension users can add tags and remarks during calls they receive, and review or edit call notes in the corresponding call logs.
  • 0: Disabled.
  • 1: Enabled.
enb_call_note_outbound 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.
  • 0: Disabled.
  • 1: Enabled.
Presence
presence_list Array<Presence> The list of custom statuses.
Filter Number
enb_number_filter Integer Whether the system automatically removes all special characters (except digits, +, *, and #) from the dialed number before sending it to the trunk.
  • 0: Disabled.
  • 1: Enabled.
DTMF
enb_dtmf_passthrough Integer Whether PBX passes DTMF tones directly to the other party without processing them.
  • 0: Disabled.
  • 1: Enabled.
dtmf_duration Integer The duration (in millisecond) of DTMF audio signal sent by the PBX.
dtmf_gap Integer The interval (in millisecond) between consecutive DTMF audio signals sent by the PBX.
Extension Preferences
ext_start String The start of the extension number range.
ext_end String The end of the extension number range.
parking_start String The start of the parking lot number range.
parking_end String The end of the parking lot number range.
vm_group_start String The start of the group voicemail number range.
vm_group_end String The end of the group voicemail number range.
ivr_start String The start of the IVR number range.
ivr_end String The end of the IVR number range.
ring_group_start String The start of the ring group number range.
ring_group_end String The end of the ring group number range.
queue_start String The start of the queue number range.
queue_end String The end of the queue number range.
conference_start String The start of the conference number range.
conference_end String The end of the conference number range.
paging_start String The start of the paging group number range.
paging_end String The end of the paging group number range.
account_start String The start of the account trunk number range.
account_end String The end of the account trunk number range.
webrtc_trunk_start String The start of the WebRTC trunk number range.
webrtc_trunk_end String The end of the WebRTC trunk number range.
cfd_start String The start of the call flow number range.
cfd_end String The end of the call flow number range.
Presence
Parameter Type Description
display_icon Integer The icon representing the custom status.
  • 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.
position Integer The sort order of the custom status.
display_changed Integer Whether the custom status has been changed.
  • 0: Disabled.
  • 1: Enabled.
origin_presence String The original status.

Example

Request example

GET /openapi/v1.0/preference/get?access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1
Host: 192.168.5.150:8088

Response example

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,
    "fxo_mode": "FCC",
    "tone_region": "us",
    "enb_dtmf_passthrough": 0,
    "dtmf_duration": 120,
    "dtmf_gap": 120,
    "flash_event": "threewaycall",
    "enb_ring_back": 0,
    "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,
    
    
    "enb_diversion_for_ext_forwarding": 0,
    "enb_message_read_receipt": 0
  }
}