Query Information of Multiple Extensions

Query the detailed information of multiple extensions at the same time.

Request URL

GET {base_url}/{api_path}/extension/query?access_token={access_token}

Request parameters

Parameter Required Type Description
ids Yes String The unique ID(s) of extension(s).
Note:

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 Array <Ext_DetailInfo> The detailed information of extension.
Ext_DetailInfo
Parameter Type Description
id Integer Extension ID.
type String Extension type.
  • SIP: SIP extension
avatar String The file ID of the extension's avatar.
Note: This parameter returns an empty string if the system default avatar is used.
first_name String First name.
last_name String Last name.
email_addr String Email address.
mobile_number String Mobile number.
organization_list Array <Organization_Info> The organization(s) to which the extension belongs.
role_id Integer The ID of the user role.
title String The job title of the extension user.
email_language String The language of email notifications for the extension.
  • follow_system: The default system email language.
  • zh-cn: 简体中文 (Chinese Simplified)
  • en: English
  • ru: Pусский (Russian)
  • de: Deutsch (German)
  • fr: Française (French)
  • bp: Português Brasil (Portuguese Brazil)
  • it: Italiano (Italian)
  • tr: Türkçe (Turkish)
user_lang String The language of the system prompts heard by the extension during a call.
  • follow_system: The default system prompt language.
  • sound-ar: العربية (Arabic)
  • sound-cz: Čeština(Czech)
  • sound-de: Deutsch (German)
  • sound-en: English
  • sound-en_BR: English (British)
  • sound-es: Español/Castellano (Spanish Spain)
  • sound-es_LT: Español latino (Spanish Latin)
  • sound-fa: فارسی (Persian)
  • sound-fr: Française (French)
  • sound-gr: Ελληνικά (Greek)
  • sound-hr: hrvatski (Croatian)
  • sound-id: Bahasa Indonesia (Indonesian)
  • sound-it: Italiano (Italian)
  • sound-iw: עברית (Hebrew)
  • sound-nl: Nederlands (Dutch)
  • sound-pl: Polski (Polish)
  • sound-pt: Português (Portuguese)
  • sound-pt_BR: Português Brasil (Portuguese Brazil)
  • sound-ro: Română (Romanian)
  • sound-ru: Pусский (Russian)
  • sound-sk: Slovenčina(Slovak)
  • sound-sl: Slovenščina (Slovenian)
  • sound-sr: Cрпски (Serbian)
  • sound-th: ไทย (Thai)
  • sound-tr: Türk (Turkish)
  • sound-zh: 中文 (Chinese)
  • sound-zh_hk: 粤语 (Cantonese)
vm_lang String

The language of the system prompts heard by caller when they access the extension's voicemail box.

  • follow_system: The default system prompt language.
  • sound-ar: العربية (Arabic)
  • sound-cz: Čeština(Czech)
  • sound-de: Deutsch (German)
  • sound-en: English
  • sound-en_BR: English (British)
  • sound-es: Español/Castellano (Spanish Spain)
  • sound-es_LT: Español latino (Spanish Latin)
  • sound-fa: فارسی (Persian)
  • sound-fr: Française (French)
  • sound-gr: Ελληνικά (Greek)
  • sound-hr: hrvatski (Croatian)
  • sound-id: Bahasa Indonesia (Indonesian)
  • sound-it: Italiano (Italian)
  • sound-iw: עברית (Hebrew)
  • sound-nl: Nederlands (Dutch)
  • sound-pl: Polski (Polish)
  • sound-pt: Português (Portuguese)
  • sound-pt_BR: Português Brasil (Portuguese Brazil)
  • sound-ro: Română (Romanian)
  • sound-ru: Pусский (Russian)
  • sound-sk: Slovenčina(Slovak)
  • sound-sl: Slovenščina (Slovenian)
  • sound-sr: Cрпски (Serbian)
  • sound-th: ไทย (Thai)
  • sound-tr: Türk (Turkish)
  • sound-zh: 中文 (Chinese)
  • sound-zh_hk: 粤语 (Cantonese)
number String Extension number.
caller_id String Caller ID.
reg_name String Registration name.
reg_password String Registration password.
Note: For security reasons, the registration password is not returned. You can retrieve the password using the Query Password of an Extension interface.
concurrent_registrations Integer IP phone concurrent registrations.
  • 1
  • 2
  • 3
  • 4
  • 5

emergency_caller_id

String

Emergency Outbound Caller ID.

enb_set_dod

Integer

 Whether the extension user can select a specific DOD number and its corresponding trunk for outgoing calls.
  • 0: Disabled
  • 1: Enabled

dod_list

 Array<DOD_Setting>

The list of DOD settings.
presence_status String Default extension presence.
  • available: Available
  • away: Away
  • business_trip: Business Trip
  • do_not_disturb: Do Not Disturb (DND)
  • lunch: Lunch Break
  • off_work: Off Work
custom_presence_status String Custom extension presence.
presence_list Array <Presence_Setting> The list of the presence settings.
agent_id String

The agent ID that will be announced in the greeting prompt to callers when their inbound calls are answered by queue agent.

By default, the extension number will be announced.
enb_vm Integer Whether the voicemail is enabled.
  • 0: Disabled
  • 1: Enabled
enb_vm_pin Integer Whether the voicemail PIN authentication is enabled.
  • 0: Disabled
  • 1: Enabled
vm_pin String The PIN code to access voicemail.
new_vm_notification String Whether the extension user will be notified when receiving a new voicemail message email, and how to notify.
  • no: Do not send email notifications.
  • with_attach: Send a notification email with the new voicemail message attached as a .wav file.
  • without_attach: Send a notification email without attaching the new voicemail message.
vm_after_notification String How to deal with the voicemail message after sending an email or a SMS message to notify the recipient.
  • no: Keep the voicemail message as unread.
  • mark_read: Keep the voicemail message as read.
  • delete: Delete the voicemail message.
enb_vm_play_datetime Integer Whether to announce the message arrival time before playing the voicemail message.
  • 0: Disabled
  • 1: Enabled
vm_play_time_format String The time format for announcing the message arrival time.
  • follow_system: Follow the system setting (Set on System > Date and Time > Display Format > Time Display Format).
  • 12-hour: 12-hour format
  • 24-hour: 24-hour format
enb_all_busy_mode_for_endpoints Integer

Whether new incoming calls will be forwarded to the Busy destination when any endpoint registered to the extension is busy on a call.

  • 0: Disabled
  • 1: Enabled
enb_all_reject_mode_for_endpoints Integer Whether other endpoints will stop ringing when the incoming call is rejected on one of the endpoints (with the extension registered).
  • 0: Disabled. When an incoming call is rejected on one endpoint, other endpoints still ring.
  • 1: Enabled. When an incoming call is rejected on one endpoint, other endpoints will stop ringing.
dtmf_mode String DTMF mode.
  • rfc4733: RFC4733 (RFC2833)
  • info: Info
  • inband: Inband
  • auto: Auto
transport String Transport protocol.
  • udp: UDP protocol
  • tcp: TCP protocol
  • tls: TLS protocol
enb_qualify Integer Whether the Qualify is enabled.
  • 0: Disabled
  • 1: Enabled
enb_t38_support Integer Whether the T.38 fax is enabled.
  • 0: Disabled
  • 1: Enabled
enb_srtp Integer Whether the SRTP is enabled.
  • 0: Disabled
  • 1: Enabled
enb_monitor_call_quality Integer Whether call quality monitoring is enabled.
  • 0: Disabled
  • 1: Enabled
monitoring_end_timestamp Integer The timestamp indicating when call quality monitoring ends.
disable_outb_call Integer Whether outbound call is allowed.
  • 0: Allow to make outbound calls.
  • 1: NOT allowed to make outbound calls.
disable_outb_call_outside_business_hours Integer

Whether outbound call outside Business Hours is allowed.

  • 0: Allow to make outbound calls outside Business Hours.
  • 1: NOT allowed to make outbound calls outside Business Hours.
disable_international_call Integer Whether international call is allowed.
  • 0: Allow to make international calls.
  • 1: NOT allowed to make international calls.
max_outb_call_duration Integer The maximum call duration of an outbound call made from the extension.
  • -1: Follow system setting.
  • 0: Unlimited.
  • Other value: The maximum call duration in seconds.
outbound_route_permission Array <Integer> The unique ID(s) of outbound route(s) that the extension is allowed to use.
tfa_enable Integer Whether the extension user has enabled 2FA.
  • 0: Disabled
  • 1: Enabled
permitted_tfa_method String The verification methods available to the extension user when enabling 2FA.
  • all: Allow the extension user to use an authenticator application or email for verification.
  • validator: Allow the extension user to use an authenticator application only.
  • email: Allow the extension user to use email only.
make_tfa_mandatory Integer

Whether the extension user is required to use 2FA.

  • 0: Disabled
  • 1: Enabled
enb_mobile_client Integer Whether the Linkus Mobile Client is enabled.
  • 0: Disabled
  • 1: Enabled
enb_web_client Integer Whether the Linkus Web Client is enabled.
  • 0: Disabled
  • 1: Enabled
enb_desktop_client Integer Whether the Linkus Desktop Client is enabled.
  • 0: Disabled
  • 1: Enabled
enb_pad_client Integer Whether the Linkus Pad Client (SDK) is enabled.
  • 0: Disabled
  • 1: Enabled
enb_internal_client Integer Reserved.
linkus_mobile_codec String Codec for Linkus Mobile Client.
  • ulaw
  • alaw
  • ilbc
  • g722
  • g729
  • opus
client_conf_list Array <Linkus_Clients_Setting> The list of the Linkus Clients settings.
moh String

The music played when the extension user places a call on hold.

  • follow_system: Follow system setting (Set on PBX Settings > Voice Prompt > Prompt Preferences > Music on Hold).

  • Other value: The name of the MoH (Music on Hold) playlist.
call_forward_moh String
The music played for the caller when the call is forwarded to another destination.
  • follow_system: Follow system setting (Set on PBX Settings > Voice Prompt > Prompt Preferences > Music on Hold for Call Forwarding).

  • Other value: The name of the MoH (Music on Hold) playlist.
ringback_tone_moh String The prompt played to the caller before the extension user answers the call.
  • follow_system: Follow system setting.
  • Empty string: Continue to play the previous stage's prompt; if no prompt exists, play the caller's own ring tone (beep sound).
  • Other value: The filename of custom prompt.
vm_greeting String The default greeting played to the callers before they record voicemail messages.
  • follow_system: Follow system setting (Set on Call feature > Voicemail > Voicemail Settings > Greeting Options > Global Voicemail Greeting).
  • no_greeting: No greeting played.
  • Other value: The filename of the voicemail greeting.
enb_missed_call_auto_reply Integer Whether the Auto-Reply Message for Missed Calls feature is enabled for the extension.
  • 0: Disabled
  • 1: Enabled
missed_call_auto_reply Object <Missed_Call_Auto_Reply> The configuration for auto-reply messages on missed inbound extension calls.
outbound_recording_prompt String The prompt played to notify both call participants of an outbound call that the call is being recorded before recording starts.
  • none: No prompt is played.
  • follow_system: Follow the system setting (configured on Call Features > Recording > Recording Tones > Outbound Call Being Recorded Prompt).
  • Other value: The filename of the custom prompt.

timezone_id

Integer

 The ID of the extension's time zone.

office_time_type

String
Business hours type.
  • timezone: Use business hours configured for this time zone.
  • custom: Use custom business hours.

office_time_list

 Array<Custom_Business_Hours> The extension's custom business hours.

presence_office_time_switch

String

The presence status to switch to automatically during business hours.

  • available
  • away
  • do_not_disturb
  • lunch
  • business_trip
  • off_work

presence_break_time_switch

String

The presence status to switch to automatically during break hours.

  • available
  • away
  • do_not_disturb
  • lunch
  • business_trip
  • off_work

presence_holiday_switch

String

The presence status to switch to automatically during holidays.

  • available
  • away
  • do_not_disturb
  • lunch
  • business_trip
  • off_work

presence_other_time_switch

String

The presence status to switch to automatically outside business hours.

  • available
  • away
  • do_not_disturb
  • lunch
  • business_trip
  • off_work

allow_reg_remotely

Integer

Whether users are allowed to register a SIP extension on the PBX remotely.

  • 0: Disabled
  • 1: Enabled

enb_user_agent_ident

Integer

Whether extension registration is restricted based on user agent.

  • 0: Disabled
  • 1: Enabled

user_agent_ident_list

 Array<User_Agent>

The list of user agents.

enb_ip_rstr

Integer

Whether extension registration is restricted based on IP address.

  • 0: Disabled
  • 1: Enabled

ip_rstr_list

 Array<IP_List>

The list of IP addresses.
vm_new_email_notify Integer Whether the new voicemail email notification is enabled.
  • 0: Disabled
  • 1: Enabled
vm_email_with_audio Integer Whether the new voicemail email notification has the .wav audio file converted from the voicemail attached.
  • 0: No
  • 1: Yes
vm_new_sms_notify Integer Whether the new voicemail SMS notification is enabled.
  • 0: Disabled
  • 1: Enabled
vm_sms_with_audio Integer Whether the new voicemail SMS notification has the .wav audio file converted from the voicemail attached.
  • 0: No
  • 1: Yes
vm_sms_recipient_type String The type of the recipient number.
  • ext_mobile: Extension mobile number
  • custom: Custom number
vm_sms_country_code String The country/region code of the custom recipient number for new voicemail SMS notification.
vm_sms_number String The custom recipient number for new voicemail SMS notification.
vm_sms_content_type String The type of the content for new voicemail SMS notification.
  • default
  • custom
vm_sms_custom_content String The custom content for new voicemail SMS notification.
vm_sms_loop_enb Integer Whether the repeat reminder for new voicemail SMS notification is enabled.
  • 0: Disabled
  • 1: Enabled
vm_sms_loop_interval Integer The retry interval in minutes to send new voicemail SMS notification repeatedly.
vm_sms_loop_max_times Integer The maximum repeat count to send new voicemail SMS notification.
vm_send_to String The type of target email address for new voicemail email notification.
  • user_email: Extension email address
  • custom_email: Custom email address
voice_email_addr String The custom email address for new voicemail email notification.
Organization_Info
Parameter Type Description
text String The name of the organization to which the extension belongs.
value String The unique ID of the organization.
DOD_Setting
Parameter Type Description

dod_number

String

The DOD number.

label

String

The display name.

pos

Integer

 The sort order.

trunk_inline_id

Integer

 The ID of the trunk associated with the DOD number.
Presence_Setting
Parameter Type Description
status String Extension presence.
  • available: Available
  • away: Away
  • business_trip: Business Trip
  • do_not_disturb: Do Not Disturb (DND)
  • lunch: Lunch Break
  • off_work: Off Work
enb_in_always_forward Integer Whether internal incoming calls will always be forwarded to a specific destination (Always condition).
  • 0: Disabled
  • 1: Enabled
in_always_forward_dest String The destination type for internal call forwarding in Always condition.
  • extension: Extension
  • ext_vm: Extension Voicemail
  • ivr: IVR
  • call_flow: Call Flow
  • ring_group: Ring Group
  • queue: Queue
  • group_vm: Group Voicemail
  • mobile_number: Mobile Number
  • external_num: External Number
  • play_greeting: Play Greeting then Hang up
  • end_call: Hang Up the call with a SIP 480 response.
  • send_busy: Hang Up the call with a SIP 486 response.
in_always_forward_prefix String The parameter returns different values depending on the destination type for internal call forwarding in Always condition.
  • When the destination type is mobile_number or external_num, the parameter returns the dial-out prefix of the external destination number.
  • When the destination type is play_greeting, the parameter returns the play count of the greeting.
in_always_forward_value String The destination for internal call forwarding in Always condition.
  • When the destination type is play_greeting, this parameter returns the custom prompt file name. E.g. demo.wav.
  • When the destination type is extension, ivr, ring_group, queue, or group_vm, this parameter returns the unique ID of the destination.

    For example, the destination is the extension 2002, then this parameter returns the extension ID 2.
in_always_forward_num String The external number of the external_num destination for internal call forwarding in Always condition.
enb_in_no_answer_forward Integer Whether internal incoming calls will be forwarded to a specific destination when the calls are not answered (No Answer condition).
  • 0: Disabled
  • 1: Enabled
in_no_answer_forward_dest String The destination type for internal call forwarding in No Answer condition.
  • extension: Extension
  • ext_vm: Extension Voicemail
  • ivr: IVR
  • call_flow: Call Flow
  • ring_group: Ring Group
  • queue: Queue
  • group_vm: Group Voicemail
  • mobile_number: Mobile Number
  • external_num: External Number
  • play_greeting: Play Greeting then Hang up
  • end_call: Hang Up the call with a SIP 480 response.
  • send_busy: Hang Up the call with a SIP 486 response.
in_no_answer_forward_prefix String The parameter returns different values depending on the destination type for internal call forwarding in No Answer condition.
  • When the destination type is mobile_number or external_num, the parameter returns the dial-out prefix of the external destination number.
  • When the destination type is play_greeting, the parameter returns the play count of the greeting.
in_no_answer_forward_value String The destination for internal call forwarding in No Answer condition.
  • When the destination type is play_greeting, this parameter returns the custom prompt file name. E.g. demo.wav.
  • When the destination type is extension, ivr, ring_group, queue, or group_vm, this parameter returns the unique ID of the destination.

    For example, the destination is the extension 2002, then this parameter returns the extension ID 2.
in_no_answer_forward_num String The external number of the external_num destination for internal call forwarding in No Answer condition.
enb_in_busy_forward Integer Whether internal incoming calls will be forwarded to a specific destination when the extension is busy (When Busy condition).
  • 0: Disabled
  • 1: Enabled
in_busy_forward_dest String The destination type for internal call forwarding in When Busy condition.
  • extension: Extension
  • ext_vm: Extension Voicemail
  • ivr: IVR
  • call_flow: Call Flow
  • ring_group: Ring Group
  • queue: Queue
  • group_vm: Group Voicemail
  • mobile_number: Mobile Number
  • external_num: External Number
  • play_greeting: Play Greeting then Hang up
  • end_call: Hang Up the call with a SIP 480 response.
  • send_busy: Hang Up the call with a SIP 486 response.
in_busy_forward_prefix String The parameter returns different values depending on the destination type for internal call forwarding in When Busy condition.
  • When the destination type is mobile_number or external_num, the parameter returns the dial-out prefix of the external destination number.
  • When the destination type is play_greeting, the parameter returns the play count of the greeting.
in_busy_forward_value String The destination for internal call forwarding in When Busy condition.
  • When the destination type is play_greeting, this parameter returns the custom prompt file name. E.g. demo.wav.
  • When the destination type is extension, ivr, ring_group, queue, or group_vm, this parameter returns the unique ID of the destination.

    For example, the destination is the extension 2002, then this parameter returns the extension ID 2.
in_busy_forward_num String The external number of the external_num destination for internal call forwarding in When Busy condition.
enb_ex_always_forward Integer Whether external incoming calls will always be forwarded to a specific destination (Always condition).
  • 0: Disabled
  • 1: Enabled
ex_always_forward_dest String The destination type for external call forwarding in Always condition.
  • extension: Extension
  • ext_vm: Extension Voicemail
  • ivr: IVR
  • call_flow: Call Flow
  • ring_group: Ring Group
  • queue: Queue
  • group_vm: Group Voicemail
  • mobile_number: Mobile Number
  • external_num: External Number
  • play_greeting: Play Greeting then Hang up
  • end_call: Hang Up the call with a SIP 480 response.
  • send_busy: Hang Up the call with a SIP 486 response.
ex_always_forward_prefix String The parameter returns different values depending on the destination type for external call forwarding in Always condition.
  • When the destination type is mobile_number or external_num, the parameter returns the dial-out prefix of the external destination number.
  • When the destination type is play_greeting, the parameter returns the play count of the greeting.
ex_always_forward_value String The destination for external call forwarding in Always condition.
  • When the destination type is play_greeting, this parameter returns the custom prompt file name. E.g. demo.wav.
  • When the destination type is extension, ivr, ring_group, queue, or group_vm, this parameter returns the unique ID of the destination.

    For example, the destination is the extension 2002, then this parameter returns the extension ID 2.
ex_always_forward_num String The external number of the external_num destination for external call forwarding in Always condition.
enb_ex_no_answer_forward Integer Whether external incoming calls will be forwarded to a specific destination when the calls are not answered (No Answer condition).
  • 0: Disabled
  • 1: Enabled
ex_no_answer_forward_dest String The destination type for external call forwarding in No Answer condition.
  • extension: Extension
  • ext_vm: Extension Voicemail
  • ivr: IVR
  • call_flow: Call Flow
  • ring_group: Ring Group
  • queue: Queue
  • group_vm: Group Voicemail
  • mobile_number: Mobile Number
  • external_num: External Number
  • play_greeting: Play Greeting then Hang up
  • end_call: Hang Up the call with a SIP 480 response.
  • send_busy: Hang Up the call with a SIP 486 response.
ex_no_answer_forward_prefix String The parameter returns different values depending on the destination type for external call forwarding in No Answer condition.
  • When the destination type is mobile_number or external_num, the parameter returns the dial-out prefix of the external destination number.
  • When the destination type is play_greeting, the parameter returns the play count of the greeting.
ex_no_answer_forward_value String The destination for external call forwarding in No Answer condition.
  • When the destination type is play_greeting, this parameter returns the custom prompt file name. E.g. demo.wav.
  • When the destination type is extension, ivr, ring_group, queue, or group_vm, this parameter returns the unique ID of the destination.

    For example, the destination is the extension 2002, then this parameter returns the extension ID 2.
ex_no_answer_forward_num String The external number of the external_num destination for external call forwarding in No Answer condition.
enb_ex_busy_forward Integer Whether external incoming calls will be forwarded to a specific destination when the extension is busy (When Busy condition).
ex_busy_forward_dest String The destination type for external call forwarding in When Busy condition.
  • extension: Extension
  • ext_vm: Extension Voicemail
  • ivr: IVR
  • call_flow: Call Flow
  • ring_group: Ring Group
  • queue: Queue
  • group_vm: Group Voicemail
  • mobile_number: Mobile Number
  • external_num: External Number
  • play_greeting: Play Greeting then Hang up
  • end_call: Hang Up the call with a SIP 480 response.
  • send_busy: Hang Up the call with a SIP 486 response.
ex_busy_forward_prefix String The parameter returns different values depending on the destination type for external call forwarding in When Busy condition.
  • When the destination type is mobile_number or external_num, the parameter returns the dial-out prefix of the external destination number.
  • When the destination type is play_greeting, the parameter returns the play count of the greeting.
ex_busy_forward_value String The destination for external call forwarding in When Busy condition.
  • When the destination type is play_greeting, this parameter returns the custom prompt file name. E.g. demo.wav.
  • When the destination type is extension, ivr, ring_group, queue, or group_vm, this parameter returns the unique ID of the destination.

    For example, the destination is the extension 2002, then this parameter returns the extension ID 2.
ex_busy_forward_num String The external number of the external_num destination for external call forwarding in When Busy condition.
ring_timeout Integer The ringing timeout for incoming calls (Unit: Second).
enb_ring_mobile Integer Whether the mobile phone will ring simultaneously when the extension rings.
  • 0: Disabled
  • 1: Enabled
mobile_prefix String The dial-out prefix of the mobile number for the "Ring the Mobile Number Simultaneously" feature.
mobile_number String Mobile number.
enb_accept_call_from_rg Integer

Whether incoming calls from ring group are accepted when the extension is in specific presence status.

  • 0: Disabled
  • 1: Enabled
vm_greeting String The presence greeting played to the callers before they record voicemail messages.
  • no_greeting: No greeting played.
  • Empty string: Follow the default extension voicemail greeting (Set on Extension and Trunk > Extension > Voicemail > Voicemail Greeting > Default Greeting ).
  • Other value: The filename of the voicemail greeting.
in_always_forward_call_confirm Integer Whether call confirmation is enabled for internal calls forwarded under the Always condition.
  • 0: Disabled
  • 1: Enabled
in_no_answer_forward_call_confirm Integer Whether call confirmation is enabled for internal calls forwarded under the No Answer condition.
  • 0: Disabled
  • 1: Enabled
in_busy_forward_call_confirm Integer Whether call confirmation is enabled for internal calls forwarded under the When Busy condition.
  • 0: Disabled
  • 1: Enabled
ex_always_forward_call_confirm Integer Whether call confirmation is enabled for external calls forwarded under the Always condition.
  • 0: Disabled
  • 1: Enabled
ex_no_answer_forward_call_confirm Integer Whether call confirmation is enabled for external calls forwarded under the No Answer condition.
  • 0: Disabled
  • 1: Enabled
ex_busy_forward_call_confirm Integer Whether call confirmation is enabled for external calls forwarded under the When Busy condition.
  • 0: Disabled
  • 1: Enabled
mobile_call_confirm Integer Whether Call Confirmation is enabled for the mobile number simultaneous ringing feature.
  • 0: Disabled
  • 1: Enabled
Custom_Business_Hours
Parameter Type Description
months String The months during which the business hour applies.
  • all: Every month.
  • jan: January.
  • feb: February.
  • mar: March.
  • apr: April.
  • may: May.
  • jun: June.
  • jul: July.
  • aug: August.
  • sep: September.
  • oct: October.
  • nov: November.
  • dec: December.
days_of_week String The days of the week on which the business hour applies.
  • all: Every day.
  • sun: Sunday.
  • mon: Monday.
  • tue: Tuesday.
  • wed: Wednesday.
  • thu: Thursday.
  • fri: Friday.
  • sat: Saturday.
days String The days of the month on which the business hour applies.
  • all: Every day of the month.
  • 1-31: The specified day or days of the month.

office_times

 Array<Time_Period> The list of office time periods.

reset_times

 Array<Time_Period> The list of break time periods.
time_condition_switch Integer Whether the advanced time condition is enabled.
  • 0: Disabled.
  • 1: Enabled.
Time_Period
Parameter Type Description
value String The time period, in the format HH:MM-HH:MM.
User_Agent
Parameter Type Description

id

Integer

The ID of the record.

user_agent

String

The User-Agent string used to identify the device.
IP_List
Parameter Type Description

id

Integer

The ID of the record.

permitted_ip

String

The permitted IP address.

netmask

String

The subnet mask.
Linkus_Clients_Setting
Parameter Type Description
id Integer Linkus Client ID.
client String Linkus Client type.
  • linkusmobile: Linkus Mobile Client
  • linkusdesktop: Linkus Desktop Client
  • linkusweb: Linkus Web Client
enb_call_waiting Integer Whether a second call can be received while the extension is already on the phone.
  • 0: Disabled
  • 1: Enabled
enb_auto_answer Integer Whether non-paging/intercom calls to the extension will be automatically answered.
  • 0: Disabled
  • 1: Enabled
auto_answer_delay_time Integer The amount of time in seconds that callers have to wait before their non-paging/intercom calls are auto-answered.
Note: 0 indicates that incoming call will be auto-answered immediately.
enb_auto_answer_tone Integer Whether a tone will be played to alert the extension when a non-paging/intercom call is automatically answered.
  • 0: Disabled
  • 1: Enabled
enb_auto_answer_paging Integer Whether paging/intercom calls to the extension will be automatically answered.
  • 0: Disabled
  • 1: Enabled
enb_auto_answer_paging_barge Integer Whether paging/intercom calls to the extension will be automatically answered when the extension is already on the phone.
  • 0: Disabled
  • 1: Enabled
enb_auto_answer_paging_tone Integer Whether a tone will be played to alert the extension when a paging/intercom call is automatically answered.
  • 0: Disabled
  • 1: Enabled
call_pop_switch Integer Whether automatic call popup will be triggered to display customer data when the extension receives an incoming call.
  • 0: Disabled
  • 1: Enabled
open_contact_url String The third-party URL for the call popup.
notify_when String When the call popup will be automatically triggered.
  • ringing: An incoming call reaches.
  • answered: An incoming call is answered.
  • hang_up: An incoming call is ended.
communication_type_list Array<String> Which types of calls will trigger the call popup.
  • internal: Internal calls from colleagues.
  • inbound: Inbound calls from external users.
max_clients Integer The maximum number of Linkus Clients that can be simultaneously logged in to the extension.
  • 1
  • 2
  • 3
Missed_Call_Auto_Reply
Parameter Type Description
call_status_list Array<String> The missed call status that triggers the automatic message reply.
  • caller_abort: The caller hangs up actively while the inbound call is ringing.
  • voicemail: The call is forwarded to the extension voicemail.
  • group_vm: The call is forwarded to a group voicemail.
  • play_greeting_hangup: The system plays greeting for the caller and hangs up the call.
  • busy: The extension is busy.
  • hangup: The extension user hangs up the call.
enb_send_sms Integer Whether automatically replying messages via SMS messaging channel is enabled.
  • 0: Disabled
  • 1: Enabled
enb_send_whatsapp Integer Whether automatically replying messages via WhatsApp messaging channel is enabled.
  • 0: Disabled
  • 1: Enabled
sms_config Object <SMS_Channel_Auto_Reply> The configuration for auto-reply SMS messages.
whatsapp_config Object <WhatsApp_Channel_Auto_Reply> The configuration for auto-reply WhatsApp messages.

SMS_Channel_Auto_Reply

Parameter Type Description
content String The content to be sent.
did_id Integer The DID number of SMS messaging channel.
msg_type Integer The type of the SMS message.
  • 1: Text.
file_content String Useless parameters.

WhatsApp_Channel_Auto_Reply

Parameter Type Description
did_id Integer The DID number of WhatsApp messaging channel.
template_params String The JSON content of WhatsApp message templates.

Examples

Request example

Query the detailed information of extensions (ID: 39 & 223).

GET /openapi/v1.0/extension/query?ids=39,223&access_token=mZFtXNfGBlo6gR9FR8Tjz0iDJRqCe3RL 

Host: yeastardocs.example.yeastarcloud.com

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": [
        {
            "id": 39,
            "first_name": "Leo",
            "last_name": "Ball",
            "email_addr": "leo@sample.com",
            "mobile_number": "15880123456",
            "role_id": 1,
            "user_lang": "follow_system",
            "caller_id": "2000",
            "title": "",
            "reg_name": "2000",
            "reg_password": "",
            "concurrent_registrations": 1,
            "type": "SIP",
            "number": "2000",
            "dtmf_mode": "rfc4733",
            
            "enb_qualify": 1,
            "enb_srtp": 0,
            "enb_t38_support": 0,
            "transport": "udp",
            "enb_vm": 1,
            "enb_vm_pin": 1,
            "vm_pin": "6666",
            "new_vm_notification": "no",
            "vm_lang": "sound-zh",
            "vm_after_notification": "delete",
            
            "disable_international_call": 0,
            "disable_outb_call_outside_business_hours": 0,
            "disable_outb_call": 0,
            "enb_mobile_client": 1,
            "enb_desktop_client": 1,
            "enb_web_client": 1,
            "enb_pad_client": 1,
            "enb_internal_client": 0,
            "presence_status": "available",
            "custom_presence_status": "Available (Work)",
            "agent_id": "5630",
            "presence_list": [
            {
                "status": "available",
                "enb_in_always_forward": 0,
                "in_always_forward_dest": "ext_vm",
                "in_always_forward_prefix": "",
                "in_always_forward_value": "",
                "in_always_forward_num": "",
                "enb_in_no_answer_forward": 1,
                "in_no_answer_forward_dest": "extension",
                "in_no_answer_forward_prefix": "",
                "in_no_answer_forward_value": "2",
                "in_no_answer_forward_num": "",
                "enb_in_busy_forward": 1,
                "in_busy_forward_dest": "ext_vm",
                "in_busy_forward_prefix": "",
                "in_busy_forward_value": "",
                "in_busy_forward_num": "",
                "enb_ex_always_forward": 0,
                "ex_always_forward_dest": "ext_vm",
                "ex_always_forward_prefix": "",
                "ex_always_forward_value": "",
                "ex_always_forward_num": "",
                "enb_ex_no_answer_forward": 1,
                "ex_no_answer_forward_dest": "ivr",
                "ex_no_answer_forward_prefix": "",
                "ex_no_answer_forward_value": "1",
                "ex_no_answer_forward_num": "",
                "enb_ex_busy_forward": 1,
                "ex_busy_forward_dest": "end_call",
                "ex_busy_forward_prefix": "",
                "ex_busy_forward_value": "",
                "ex_busy_forward_num": "",
                "enb_ring_mobile": 1,
                "mobile_prefix": "",
                "mobile_number": "123123123",
                "ring_timeout": 30,
                "enb_accept_call_from_rg": 1,
                "vm_greeting": "",
                "in_always_forward_call_confirm": 0,
                "in_no_answer_forward_call_confirm": 0,
                "in_busy_forward_call_confirm": 0,
                "ex_always_forward_call_confirm": 0,
                "ex_no_answer_forward_call_confirm": 0,
                "ex_busy_forward_call_confirm": 0,
                "mobile_call_confirm": 1
            },
            {
                "status": "away",
                "enb_in_always_forward": 0,
                "in_always_forward_dest": "ext_vm",
                "in_always_forward_prefix": "",
                "in_always_forward_value": "",
                "in_always_forward_num": "",
                "enb_in_no_answer_forward": 1,
                "in_no_answer_forward_dest": "ring_group",
                "in_no_answer_forward_prefix": "",
                "in_no_answer_forward_value": "1",
                "in_no_answer_forward_num": "",
                "enb_in_busy_forward": 1,
                "in_busy_forward_dest": "queue",
                "in_busy_forward_prefix": "",
                "in_busy_forward_value": "1",
                "in_busy_forward_num": "",
                "enb_ex_always_forward": 0,
                "ex_always_forward_dest": "ext_vm",
                "ex_always_forward_prefix": "",
                "ex_always_forward_value": "",
                "ex_always_forward_num": "",
                "enb_ex_no_answer_forward": 1,
                "ex_no_answer_forward_dest": "group_vm",
                "ex_no_answer_forward_prefix": "",
                "ex_no_answer_forward_value": "1",
                "ex_no_answer_forward_num": "",
                "enb_ex_busy_forward": 1,
                "ex_busy_forward_dest": "play_greeting",
                "ex_busy_forward_prefix": "5",
                "ex_busy_forward_value": "demo.wav",
                "ex_busy_forward_num": "",
                "enb_ring_mobile": 0,
                "mobile_prefix": "",
                "mobile_number": "123123123",
                "ring_timeout": 30,
                "enb_accept_call_from_rg": 0,
                "vm_greeting": "",
                "in_always_forward_call_confirm": 0,
                "in_no_answer_forward_call_confirm": 0,
                "in_busy_forward_call_confirm": 0,
                "ex_always_forward_call_confirm": 0,
                "ex_no_answer_forward_call_confirm": 0,
                "ex_busy_forward_call_confirm": 0,
                "mobile_call_confirm": 1
            },
            {
                "status": "business_trip",
                "enb_in_always_forward": 0,
                "in_always_forward_dest": "ext_vm",
                "in_always_forward_prefix": "",
                "in_always_forward_value": "",
                "in_always_forward_num": "",
                "enb_in_no_answer_forward": 1,
                "in_no_answer_forward_dest": "mobile_number",
                "in_no_answer_forward_prefix": "123",
                "in_no_answer_forward_value": "",
                "in_no_answer_forward_num": "",
                "enb_in_busy_forward": 1,
                "in_busy_forward_dest": "external_num",
                "in_busy_forward_prefix": "543",
                "in_busy_forward_value": "",
                "in_busy_forward_num": "5235235235",
                "enb_ex_always_forward": 0,
                "ex_always_forward_dest": "ext_vm",
                "ex_always_forward_prefix": "",
                "ex_always_forward_value": "",
                "ex_always_forward_num": "",
                "enb_ex_no_answer_forward": 1,
                "ex_no_answer_forward_dest": "ext_vm",
                "ex_no_answer_forward_prefix": "",
                "ex_no_answer_forward_value": "",
                "ex_no_answer_forward_num": "",
                "enb_ex_busy_forward": 1,
                "ex_busy_forward_dest": "group_vm",
                "ex_busy_forward_prefix": "",
                "ex_busy_forward_value": "1",
                "ex_busy_forward_num": "",
                "enb_ring_mobile": 0,
                "mobile_prefix": "",
                "mobile_number": "123123123",
                "ring_timeout": 30,
                "enb_accept_call_from_rg": 0,
                "vm_greeting": "",
                "in_always_forward_call_confirm": 0,
                "in_no_answer_forward_call_confirm": 1,
                "in_busy_forward_call_confirm": 1,
                "ex_always_forward_call_confirm": 0,
                "ex_no_answer_forward_call_confirm": 0,
                "ex_busy_forward_call_confirm": 0,
                "mobile_call_confirm": 1
            },
            {
                "status": "do_not_disturb",
                "enb_in_always_forward": 1,
                "in_always_forward_dest": "ext_vm",
                "in_always_forward_prefix": "",
                "in_always_forward_value": "",
                "in_always_forward_num": "",
                "enb_in_no_answer_forward": 1,
                "in_no_answer_forward_dest": "ext_vm",
                "in_no_answer_forward_prefix": "",
                "in_no_answer_forward_value": "",
                "in_no_answer_forward_num": "",
                "enb_in_busy_forward": 1,
                "in_busy_forward_dest": "ext_vm",
                "in_busy_forward_prefix": "",
                "in_busy_forward_value": "",
                "in_busy_forward_num": "",
                "enb_ex_always_forward": 1,
                "ex_always_forward_dest": "ext_vm",
                "ex_always_forward_prefix": "",
                "ex_always_forward_value": "",
                "ex_always_forward_num": "",
                "enb_ex_no_answer_forward": 1,
                "ex_no_answer_forward_dest": "ext_vm",
                "ex_no_answer_forward_prefix": "",
                "ex_no_answer_forward_value": "",
                "ex_no_answer_forward_num": "",
                "enb_ex_busy_forward": 1,
                "ex_busy_forward_dest": "ext_vm",
                "ex_busy_forward_prefix": "",
                "ex_busy_forward_value": "",
                "ex_busy_forward_num": "",
                "enb_ring_mobile": 0,
                "mobile_prefix": "",
                "mobile_number": "123123123",
                "ring_timeout": 30,
                "enb_accept_call_from_rg": 0,
                "vm_greeting": "",
                "in_always_forward_call_confirm": 0,
                "in_no_answer_forward_call_confirm": 0,
                "in_busy_forward_call_confirm": 0,
                "ex_always_forward_call_confirm": 0,
                "ex_no_answer_forward_call_confirm": 0,
                "ex_busy_forward_call_confirm": 0,
                "mobile_call_confirm": 1
            },
            {
                "status": "lunch",
                "enb_in_always_forward": 0,
                "in_always_forward_dest": "ext_vm",
                "in_always_forward_prefix": "",
                "in_always_forward_value": "",
                "in_always_forward_num": "",
                "enb_in_no_answer_forward": 1,
                "in_no_answer_forward_dest": "ext_vm",
                "in_no_answer_forward_prefix": "",
                "in_no_answer_forward_value": "",
                "in_no_answer_forward_num": "",
                "enb_in_busy_forward": 1,
                "in_busy_forward_dest": "ext_vm",
                "in_busy_forward_prefix": "",
                "in_busy_forward_value": "",
                "in_busy_forward_num": "",
                "enb_ex_always_forward": 0,
                "ex_always_forward_dest": "ext_vm",
                "ex_always_forward_prefix": "",
                "ex_always_forward_value": "",
                "ex_always_forward_num": "",
                "enb_ex_no_answer_forward": 1,
                "ex_no_answer_forward_dest": "ext_vm",
                "ex_no_answer_forward_prefix": "",
                "ex_no_answer_forward_value": "",
                "ex_no_answer_forward_num": "",
                "enb_ex_busy_forward": 1,
                "ex_busy_forward_dest": "ext_vm",
                "ex_busy_forward_prefix": "",
                "ex_busy_forward_value": "",
                "ex_busy_forward_num": "",
                "enb_ring_mobile": 0,
                "mobile_prefix": "",
                "mobile_number": "123123123",
                "ring_timeout": 30,
                "enb_accept_call_from_rg": 0,
                "vm_greeting": "",
                "in_always_forward_call_confirm": 0,
                "in_no_answer_forward_call_confirm": 0,
                "in_busy_forward_call_confirm": 0,
                "ex_always_forward_call_confirm": 0,
                "ex_no_answer_forward_call_confirm": 0,
                "ex_busy_forward_call_confirm": 0,
                "mobile_call_confirm": 1
            },
            {
                "status": "off_work",
                "enb_in_always_forward": 0,
                "in_always_forward_dest": "ext_vm",
                "in_always_forward_prefix": "",
                "in_always_forward_value": "",
                "in_always_forward_num": "",
                "enb_in_no_answer_forward": 1,
                "in_no_answer_forward_dest": "ext_vm",
                "in_no_answer_forward_prefix": "",
                "in_no_answer_forward_value": "",
                "in_no_answer_forward_num": "",
                "enb_in_busy_forward": 1,
                "in_busy_forward_dest": "ext_vm",
                "in_busy_forward_prefix": "",
                "in_busy_forward_value": "",
                "in_busy_forward_num": "",
                "enb_ex_always_forward": 0,
                "ex_always_forward_dest": "ext_vm",
                "ex_always_forward_prefix": "",
                "ex_always_forward_value": "",
                "ex_always_forward_num": "",
                "enb_ex_no_answer_forward": 1,
                "ex_no_answer_forward_dest": "ext_vm",
                "ex_no_answer_forward_prefix": "",
                "ex_no_answer_forward_value": "",
                "ex_no_answer_forward_num": "",
                "enb_ex_busy_forward": 1,
                "ex_busy_forward_dest": "ext_vm",
                "ex_busy_forward_prefix": "",
                "ex_busy_forward_value": "",
                "ex_busy_forward_num": "",
                "enb_ring_mobile": 0,
                "mobile_prefix": "",
                "mobile_number": "123123123",
                "ring_timeout": 30,
                "enb_accept_call_from_rg": 0,
                "vm_greeting": "",
                "in_always_forward_call_confirm": 0,
                "in_no_answer_forward_call_confirm": 0,
                "in_busy_forward_call_confirm": 0,
                "ex_always_forward_call_confirm": 0,
                "ex_no_answer_forward_call_confirm": 0,
                "ex_busy_forward_call_confirm": 0,
                "mobile_call_confirm": 1
            }
        ],
        "enb_all_reject_mode_for_endpoints": 1,
        "linkus_mobile_codec": "g729",
        
        "client_conf_list": [
            {
                "id": 56,
                "client": "linkusweb",
                "enb_call_waiting": 1,
                "enb_auto_answer": 0,
                "auto_answer_delay_time": 0,
                "enb_auto_answer_tone": 1,
                "enb_auto_answer_paging": 1,
                "enb_auto_answer_paging_barge": 0,
                "enb_auto_answer_paging_tone": 1,
                "call_pop_switch": 0,
                "open_contact_url": "https://web/solve.360.com/{{.CallerNumber}}&{{.CallerDisplayName}}",
                "notify_when": "ringing",
                "communication_type_list": [
                    "inbound"
                ],
                "max_clients": 1
            },
            {
                "id": 57,
                "client": "linkusdesktop",
                "enb_call_waiting": 1,
                "enb_auto_answer": 1,
                "auto_answer_delay_time": 10,
                "enb_auto_answer_tone": 1,
                "enb_auto_answer_paging": 0,
                "enb_auto_answer_paging_barge": 0,
                "enb_auto_answer_paging_tone": 1,
                "call_pop_switch": 0,
                "open_contact_url": "",
                "notify_when": "",
                "communication_type_list": null,
                "max_clients": 1
            },
            {
                "id": 58,
                "client": "linkusmobile",
                "enb_call_waiting": 0,
                "enb_auto_answer": 1,
                "auto_answer_delay_time": 5,
                "enb_auto_answer_tone": 1,
                "enb_auto_answer_paging": 1,
                "enb_auto_answer_paging_barge": 1,
                "enb_auto_answer_paging_tone": 1,
                "call_pop_switch": 0,
                "open_contact_url": "",
                "notify_when": "",
                "communication_type_list": null,
                "max_clients": 1
            }
        ],
        "enb_vm_play_datetime": 0,
        "vm_play_time_format": "follow_system",
        "email_language": "follow_system",
        "max_outb_call_duration": -1,
        "enb_all_busy_mode_for_endpoints": 1,
        "avatar": "myYtwrWoRmxBeyGrd0ff1e60-2b53-4d17-8a13-736923dab108",
        "moh": "SoftBreeze",
        "call_forward_moh": "follow_system",
        "ringback_tone_moh": "Welcome.wav",
        "vm_greeting": "Artificial.wav",
        "enb_monitor_call_quality": 0,
        "monitoring_end_timestamp": 0,
        "enb_missed_call_auto_reply": 1,
        "missed_call_auto_reply": {
            "call_status_list": [
                "caller_abort",
                "voicemail",
                "group_vm",
                "play_greeting_hangup",
                "busy"
            ],
            "enb_send_sms": 1,
            "enb_send_whatsapp": 1,
            "sms_config": {
                "did_id": 1,
                "msg_type": 0,
                "content": "xxxxxxxxxxxxxxxx",
                "file_content": ""
            },
            "whatsapp_config": {
                "did_id": 11,
                "template_params": "{\"id\":194,\"template_id\":\"1962411564407078\",\"name\":\"jaspers_market_plain_text_v1\",\"language\":{\"code\":\"en_US\"},\"components\":[],\"parameter_format\":\"POSITIONAL\"}"
            }
        },
        "outbound_recording_prompt": "follow_system",
        "vm_new_email_notify": 0,
        "vm_email_with_audio": 0,
        "vm_new_sms_notify": 1,
        "vm_sms_with_audio": 0,
        "vm_sms_recipient_type": "custom",
        "vm_sms_country_code": "1268-ag",
        "vm_sms_number": "13800138001",
        "vm_sms_content_type": "default",
        "vm_sms_custom_content": "",
        "vm_sms_loop_enb": 0,
        "vm_sms_loop_interval": 0,
        "vm_sms_loop_max_times": 0,
        "vm_send_to": "custom_email",
        "voice_email_addr": "1xxxx@163.com"
        },
        {
            "id": 223,
            "first_name": "Phillip Huff",
            "email_addr": "phillip@sample.com",
            "role_id": 1,
            "user_lang": "sound-en",
            "caller_id": "2001",
            "title": "",
            "reg_name": "1QSg2E8zd4",
            "reg_password": "",
            "concurrent_registrations": 1,
            "type": "SIP",
            "number": "2001",
            "dtmf_mode": "rfc4733",
            
            "enb_qualify": 1,
            "enb_srtp": 0,
            "enb_t38_support": 0,
            "transport": "udp",
            "enb_vm": 1,
            "enb_vm_pin": 1,
            "vm_pin": "0532",
            "new_vm_notification": "no",
            "vm_lang": "sound-zh",
            "vm_after_notification": "no",
            
            "disable_international_call": 1,
            "disable_outb_call_outside_business_hours": 0,
            "disable_outb_call": 0,
            "enb_mobile_client": 1,
            "enb_desktop_client": 1,
            "enb_web_client": 1,
            "enb_pad_client": 1,
            "enb_internal_client": 0,
            "presence_status": "available",
            "custom_presence_status": "Available (Work)",
            "presence_list": [
            {
                "status": "available",
                "enb_in_always_forward": 0,
                "in_always_forward_dest": "ext_vm",
                "in_always_forward_prefix": "",
                "in_always_forward_value": "",
                "in_always_forward_num": "",
                "enb_in_no_answer_forward": 1,
                "in_no_answer_forward_dest": "ext_vm",
                "in_no_answer_forward_prefix": "",
                "in_no_answer_forward_value": "",
                "in_no_answer_forward_num": "",
                "enb_in_busy_forward": 1,
                "in_busy_forward_dest": "ext_vm",
                "in_busy_forward_prefix": "",
                "in_busy_forward_value": "",
                "in_busy_forward_num": "",
                "enb_ex_always_forward": 0,
                "ex_always_forward_dest": "ext_vm",
                "ex_always_forward_prefix": "",
                "ex_always_forward_value": "",
                "ex_always_forward_num": "",
                "enb_ex_no_answer_forward": 1,
                "ex_no_answer_forward_dest": "ext_vm",
                "ex_no_answer_forward_prefix": "",
                "ex_no_answer_forward_value": "",
                "ex_no_answer_forward_num": "",
                "enb_ex_busy_forward": 1,
                "ex_busy_forward_dest": "end_call",
                "ex_busy_forward_prefix": "",
                "ex_busy_forward_value": "",
                "ex_busy_forward_num": "",
                "enb_ring_mobile": 1,
                "mobile_prefix": "",
                "mobile_number": "123123123",
                "ring_timeout": 30,
                "enb_accept_call_from_rg":1,
                "vm_greeting": "",
                "in_always_forward_call_confirm": 0,
                "in_no_answer_forward_call_confirm": 0,
                "in_busy_forward_call_confirm": 0,
                "ex_always_forward_call_confirm": 0,
                "ex_no_answer_forward_call_confirm": 0,
                "ex_busy_forward_call_confirm": 0,
                "mobile_call_confirm": 1
            },
            {
                "status": "away",
                "enb_in_always_forward": 0,
                "in_always_forward_dest": "ext_vm",
                "in_always_forward_prefix": "",
                "in_always_forward_value": "",
                "in_always_forward_num": "",
                "enb_in_no_answer_forward": 1,
                "in_no_answer_forward_dest": "ext_vm",
                "in_no_answer_forward_prefix": "",
                "in_no_answer_forward_value": "",
                "in_no_answer_forward_num": "",
                "enb_in_busy_forward": 1,
                "in_busy_forward_dest": "ext_vm",
                "in_busy_forward_prefix": "",
                "in_busy_forward_value": "",
                "in_busy_forward_num": "",
                "enb_ex_always_forward": 0,
                "ex_always_forward_dest": "ext_vm",
                "ex_always_forward_prefix": "",
                "ex_always_forward_value": "",
                "ex_always_forward_num": "",
                "enb_ex_no_answer_forward": 1,
                "ex_no_answer_forward_dest": "ext_vm",
                "ex_no_answer_forward_prefix": "",
                "ex_no_answer_forward_value": "",
                "ex_no_answer_forward_num": "",
                "enb_ex_busy_forward": 1,
                "ex_busy_forward_dest": "ext_vm",
                "ex_busy_forward_prefix": "",
                "ex_busy_forward_value": "",
                "ex_busy_forward_num": "",
                "enb_ring_mobile": 0,
                "mobile_prefix": "",
                "mobile_number": "123123123",
                "ring_timeout": 30,
                "enb_accept_call_from_rg": 0,
                "vm_greeting": "",
                "in_always_forward_call_confirm": 0,
                "in_no_answer_forward_call_confirm": 0,
                "in_busy_forward_call_confirm": 0,
                "ex_always_forward_call_confirm": 0,
                "ex_no_answer_forward_call_confirm": 0,
                "ex_busy_forward_call_confirm": 0,
                "mobile_call_confirm": 1
            },
            {
                "status": "business_trip",
                "enb_in_always_forward": 0,
                "in_always_forward_dest": "ext_vm",
                "in_always_forward_prefix": "",
                "in_always_forward_value": "",
                "in_always_forward_num": "",
                "enb_in_no_answer_forward": 1,
                "in_no_answer_forward_dest": "mobile_number",
                "in_no_answer_forward_prefix": "123",
                "in_no_answer_forward_value": "",
                "in_no_answer_forward_num": "",
                "enb_in_busy_forward": 1,
                "in_busy_forward_dest": "external_num",
                "in_busy_forward_prefix": "543",
                "in_busy_forward_value": "",
                "in_busy_forward_num": "5235235235",
                "enb_ex_always_forward": 0,
                "ex_always_forward_dest": "ext_vm",
                "ex_always_forward_prefix": "",
                "ex_always_forward_value": "",
                "ex_always_forward_num": "",
                "enb_ex_no_answer_forward": 1,
                "ex_no_answer_forward_dest": "ext_vm",
                "ex_no_answer_forward_prefix": "",
                "ex_no_answer_forward_value": "",
                "ex_no_answer_forward_num": "",
                "enb_ex_busy_forward": 1,
                "ex_busy_forward_dest": "group_vm",
                "ex_busy_forward_prefix": "",
                "ex_busy_forward_value": "1",
                "ex_busy_forward_num": "",
                "enb_ring_mobile": 0,
                "mobile_prefix": "",
                "mobile_number": "123123123",
                "ring_timeout": 30,
                "enb_accept_call_from_rg": 0,
                "vm_greeting": "",
                "in_always_forward_call_confirm": 0,
                "in_no_answer_forward_call_confirm": 1,
                "in_busy_forward_call_confirm": 1,
                "ex_always_forward_call_confirm": 0,
                "ex_no_answer_forward_call_confirm": 0,
                "ex_busy_forward_call_confirm": 0,
                "mobile_call_confirm": 1
            },
            {
                "status": "do_not_disturb",
                "enb_in_always_forward": 1,
                "in_always_forward_dest": "ext_vm",
                "in_always_forward_prefix": "",
                "in_always_forward_value": "",
                "in_always_forward_num": "",
                "enb_in_no_answer_forward": 1,
                "in_no_answer_forward_dest": "ext_vm",
                "in_no_answer_forward_prefix": "",
                "in_no_answer_forward_value": "",
                "in_no_answer_forward_num": "",
                "enb_in_busy_forward": 1,
                "in_busy_forward_dest": "ext_vm",
                "in_busy_forward_prefix": "",
                "in_busy_forward_value": "",
                "in_busy_forward_num": "",
                "enb_ex_always_forward": 1,
                "ex_always_forward_dest": "ext_vm",
                "ex_always_forward_prefix": "",
                "ex_always_forward_value": "",
                "ex_always_forward_num": "",
                "enb_ex_no_answer_forward": 1,
                "ex_no_answer_forward_dest": "ext_vm",
                "ex_no_answer_forward_prefix": "",
                "ex_no_answer_forward_value": "",
                "ex_no_answer_forward_num": "",
                "enb_ex_busy_forward": 1,
                "ex_busy_forward_dest": "ext_vm",
                "ex_busy_forward_prefix": "",
                "ex_busy_forward_value": "",
                "ex_busy_forward_num": "",
                "enb_ring_mobile": 0,
                "mobile_prefix": "",
                "mobile_number": "123123123",
                "ring_timeout": 30,
                "enb_accept_call_from_rg": 0,
                "vm_greeting": "",
                "in_always_forward_call_confirm": 0,
                "in_no_answer_forward_call_confirm": 0,
                "in_busy_forward_call_confirm": 0,
                "ex_always_forward_call_confirm": 0,
                "ex_no_answer_forward_call_confirm": 0,
                "ex_busy_forward_call_confirm": 0,
                "mobile_call_confirm": 1
            },
            {
                "status": "lunch",
                "enb_in_always_forward": 0,
                "in_always_forward_dest": "ext_vm",
                "in_always_forward_prefix": "",
                "in_always_forward_value": "",
                "in_always_forward_num": "",
                "enb_in_no_answer_forward": 1,
                "in_no_answer_forward_dest": "ext_vm",
                "in_no_answer_forward_prefix": "",
                "in_no_answer_forward_value": "",
                "in_no_answer_forward_num": "",
                "enb_in_busy_forward": 1,
                "in_busy_forward_dest": "ext_vm",
                "in_busy_forward_prefix": "",
                "in_busy_forward_value": "",
                "in_busy_forward_num": "",
                "enb_ex_always_forward": 0,
                "ex_always_forward_dest": "ext_vm",
                "ex_always_forward_prefix": "",
                "ex_always_forward_value": "",
                "ex_always_forward_num": "",
                "enb_ex_no_answer_forward": 1,
                "ex_no_answer_forward_dest": "ext_vm",
                "ex_no_answer_forward_prefix": "",
                "ex_no_answer_forward_value": "",
                "ex_no_answer_forward_num": "",
                "enb_ex_busy_forward": 1,
                "ex_busy_forward_dest": "ext_vm",
                "ex_busy_forward_prefix": "",
                "ex_busy_forward_value": "",
                "ex_busy_forward_num": "",
                "enb_ring_mobile": 0,
                "mobile_prefix": "",
                "mobile_number": "123123123",
                "ring_timeout": 30,
                "enb_accept_call_from_rg": 0,
                "vm_greeting": "",
                "in_always_forward_call_confirm": 0,
                "in_no_answer_forward_call_confirm": 0,
                "in_busy_forward_call_confirm": 0,
                "ex_always_forward_call_confirm": 0,
                "ex_no_answer_forward_call_confirm": 0,
                "ex_busy_forward_call_confirm": 0,
                "mobile_call_confirm": 1
            },
            {
                "status": "off_work",
                "enb_in_always_forward": 0,
                "in_always_forward_dest": "ext_vm",
                "in_always_forward_prefix": "",
                "in_always_forward_value": "",
                "in_always_forward_num": "",
                "enb_in_no_answer_forward": 1,
                "in_no_answer_forward_dest": "ext_vm",
                "in_no_answer_forward_prefix": "",
                "in_no_answer_forward_value": "",
                "in_no_answer_forward_num": "",
                "enb_in_busy_forward": 1,
                "in_busy_forward_dest": "ext_vm",
                "in_busy_forward_prefix": "",
                "in_busy_forward_value": "",
                "in_busy_forward_num": "",
                "enb_ex_always_forward": 0,
                "ex_always_forward_dest": "ext_vm",
                "ex_always_forward_prefix": "",
                "ex_always_forward_value": "",
                "ex_always_forward_num": "",
                "enb_ex_no_answer_forward": 1,
                "ex_no_answer_forward_dest": "ext_vm",
                "ex_no_answer_forward_prefix": "",
                "ex_no_answer_forward_value": "",
                "ex_no_answer_forward_num": "",
                "enb_ex_busy_forward": 1,
                "ex_busy_forward_dest": "ext_vm",
                "ex_busy_forward_prefix": "",
                "ex_busy_forward_value": "",
                "ex_busy_forward_num": "",
                "enb_ring_mobile": 0,
                "mobile_prefix": "",
                "mobile_number": "123123123",
                "ring_timeout": 30,
                "enb_accept_call_from_rg": 0,
                "vm_greeting": "",
                "in_always_forward_call_confirm": 0,
                "in_no_answer_forward_call_confirm": 0,
                "in_busy_forward_call_confirm": 0,
                "ex_always_forward_call_confirm": 0,
                "ex_no_answer_forward_call_confirm": 0,
                "ex_busy_forward_call_confirm": 0,
                "mobile_call_confirm": 1
            }
        ],
        "enb_all_reject_mode_for_endpoints": 1,
        "linkus_mobile_codec": "g729",
        
        "client_conf_list": [
                {
                    "id": 13,
                    "client": "linkusweb",
                    "enb_call_waiting": 1,
                    "enb_auto_answer": 0,
                    "auto_answer_delay_time": 0,
                    "enb_auto_answer_tone": 1,
                    "enb_auto_answer_paging": 0,
                    "enb_auto_answer_paging_barge": 0,
                    "enb_auto_answer_paging_tone": 1,
                    "call_pop_switch": 0,
                    "open_contact_url": "",
                    "notify_when": "",
                    "communication_type_list": null,
                    "max_clients": 1
                },
                {
                    "id": 14,
                    "client": "linkusdesktop",
                    "enb_call_waiting": 1,
                    "enb_auto_answer": 0,
                    "auto_answer_delay_time": 0,
                    "enb_auto_answer_tone": 1,
                    "enb_auto_answer_paging": 0,
                    "enb_auto_answer_paging_barge": 0,
                    "enb_auto_answer_paging_tone": 1,
                    "call_pop_switch": 0,
                    "open_contact_url": "",
                    "notify_when": "",
                    "communication_type_list": null,
                    "max_clients": 1
                },
                {
                    "id": 32,
                    "client": "linkusmobile",
                    "enb_call_waiting": 0,
                    "enb_auto_answer": 1,
                    "auto_answer_delay_time": 5,
                    "enb_auto_answer_tone": 1,
                    "enb_auto_answer_paging": 1,
                    "enb_auto_answer_paging_barge": 1,
                    "enb_auto_answer_paging_tone": 1,
                    "call_pop_switch": 0,
                    "open_contact_url": "",
                    "notify_when": "",
                    "communication_type_list": null,
                    "max_clients": 1
                }
            ],
        "enb_vm_play_datetime": 0,
        "vm_play_time_format": "follow_system",
        "email_language": "follow_system",
        "max_outb_call_duration": -1,
        "enb_all_busy_mode_for_endpoints": 1,
        "avatar": "",
        "moh": "SoftBreeze",
        "call_forward_moh": "follow_system",
        "ringback_tone_moh": "Welcome.wav",
        "vm_greeting": "Artificial.wav",
        "enb_monitor_call_quality": 1,
        "monitoring_end_timestamp": 1780156799,
        "enb_missed_call_auto_reply": 1,
        "missed_call_auto_reply": {
            "call_status_list": [
                "caller_abort",
                "voicemail",
                "group_vm",
                "play_greeting_hangup",
                "busy"
            ],
            "enb_send_sms": 1,
            "enb_send_whatsapp": 1,
            "sms_config": {
                "did_id": 1,
                "msg_type": 0,
                "content": "xxxxxxxxxxxxxxxx",
                "file_content": ""
            },
            "whatsapp_config": {
                "did_id": 11,
                "template_params": "{\"id\":194,\"template_id\":\"1962411564407078\",\"name\":\"jaspers_market_plain_text_v1\",\"language\":{\"code\":\"en_US\"},\"components\":[],\"parameter_format\":\"POSITIONAL\"}"
            }
        },
        "outbound_recording_prompt": "follow_system",
        "vm_new_email_notify": 0,
        "vm_email_with_audio": 0,,
        "vm_new_sms_notify": 1,
        "vm_sms_with_audio": 0,
        "vm_sms_recipient_type": "custom",
        "vm_sms_country_code": "1268-ag",
        "vm_sms_number": "13800138001",
        "vm_sms_content_type": "default",
        "vm_sms_custom_content": "",
        "vm_sms_loop_enb": 0,
        "vm_sms_loop_interval": 0,
        "vm_sms_loop_max_times": 0,
        "vm_send_to": "user_email",
        "voice_email_addr": ""
        }
    ]
}