Skip to Content
Cloud One
  • Products

    Business Communication Suite & Phone System


      By Edition

      ​Cloud

      Software

      Appliance

    By Deployment

    ​On-premise

    Hosted by Cloud One

    Self-hosted

    By Management

    ​Managed By Cloud One

    Semi-Managed by Cloud One

    Self-Managed


    Simu Connect UC Clients


    Simu Connect Web Client Simu Connect Mobile Client Simu Connect Desktop ClientSimu Connect Chrome ExtensionSimu Connect TAPI Integration

    SIP Trunks


    Business SIPPay As You Go SIP Country Presence SIPVirtual Phone NumbersGolden Phone NumbersToll Free NumbersBring Your Own Carrier (BYOC)Calling RatesTalktime Top-up

    Get a Proof of Concept Now!


    Simu Connect POC Application Managed Business Communication Suite Self Managed Business Communication SuiteSIP Trunk POCOdoo Phone POC
  • Solutions

    Business Needs


    Work from Anywhere Hosted UCaaS Self hosted UCaaSVideo ConferencingAppliance PBXAI-powered Cloud PBXWhite-label Solution

    Industry


    Call Center Healthcare HospitalityFinanceEducationLogisticsRetail BusinessGovernment Agency

    Ecosystem


    IP Phones SIP Trunks IntegrationHeadsetsVirtual Phone Numbers

    By Integration


    Odoo Phone System Zoho Phone System Salesforce Phone SystemMicrosoft Dynamics Phone SystemZendesk Phone SystemFreshdesk Phone SystemBitrix24 Phone SystemHubSpot Phone System
  • Resources

    Downloads

    Download user guides and more documents

    Book a Meeting

    Schedule a meeting at your convenience

    Developer Guide

    Read API Documentation for Cloud One BCS API

    Business Communication Suite

    Experience our user-friendly business communication suite today. Explore robust telephony features that enhance your client connections efficiently.  

    See More Details
  • Devices

    Yealink IP Phones


    Yealink T3 Series IP Phones Yealink T4 Series IP Phones Yealink T5 Series IP PhonesYealink T7 Series IP PhonesYealink T8 Series IP Phones Yealink DECT IP Phones

    Voice Conferencing Solutions


    VC Room Systems BYOD Solutions Video Phone Video Conferencing Accessories

    Microsoft Solutions


    MS Teams Rooms Systems Microsoft Phones Conference Phones HeadsetsYealink MeetingBoardYealink MeetingBoard Pro

    Zoom Rooms


    Zoom Rooms Systems Zoom Phones Zoom Cameras BYOD Solutions
  • Help

    Ticketing System


    Submit a Helpdesk TicketReport an Issue

    Training


    User TrainingOperator TrainingCall Center Agent TrainingSupervisor Training

    Frequently Asked Questions


    General FAQBCS FAQSIP Trunks FAQLocal Phone Numbers FAQ

    Contact Us


    WhatsApp Icon


  • Support Helpdesk Contact
  • +254 20 790 0100
  • support@cloudone.co

  • Accounts Helpdesk Contact
  • +254 20 790 0000
  • finance@cloudone.co
  • Visit our Office


    Cloud One Ltd

    Saachi Plaza - Unit A3, Argwings Kodhek Road, Nairobi, Kenya
    P.O.Box 76484-00508 Yaya Centre

    +254 20 790 0000

    hello@cloudone.co


    Kindly do not email multiple contacts as it creates multiple tickets on our CRM


  • Contact Us
  • Blog
    ​​
  • Sign in
  • 0
  • 0
  • Deploy in hours Certified Experts Zero Setup / License Fees*
  • Follow us
    Click here to setup your social networks
    Click here to setup your social networks
Cloud One
  • 0
  • 0
    • Products
    • Solutions
    • Resources
    • Devices
    • Help
    • Contact Us
    • Blog
  • Deploy in hours Certified Experts Zero Setup / License Fees*
  • Follow us
    Click here to setup your social networks
    Click here to setup your social networks
  • Sign in
  • ​​

Query Extension Information

Query the detailed information of an extension.

Request URL

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

Request parameters

ParameterRequiredTypeDescription
idYesIntegerThe unique ID of an extension.Note:You can query extension's ID using Search Specific Extensions.

Response parameters

ParameterTypeDescription
errcodeIntegerReturned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note:You can check the error code and error message in Error Code and Error Message.
errmsgStringReturned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
dataObject <Ext_DetailInfo>The detailed information of an extension.

Ext_DetailInfo

ParameterTypeDescription
idIntegerExtension ID.
typeStringExtension type.
  • SIP: SIP extension
avatarStringThe file ID of the extension's avatar.
Note: This parameter returns an empty string if the system default avatar is used.
first_nameStringFirst name.
last_nameStringLast name.
email_addrStringEmail address.
mobile_numberStringMobile number.
organization_listArray <Organization_Info>The organization(s) to which the extension belongs.
role_idIntegerThe ID of the user role.
titleStringThe job title of the extension user.
email_languageStringThe 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_langStringThe 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_langString

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)
numberStringExtension number.
caller_idStringCaller ID.
reg_nameStringRegistration name.
reg_passwordStringRegistration 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_registrationsIntegerSIP endpoint concurrent registrations.
  • 1
  • 2
  • 3
  • 4
  • 5
presence_statusStringDefault 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_statusStringCustom extension presence.
presence_listArray <Presence_Setting>The list of the presence settings.
agent_idString

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_vmIntegerWhether the voicemail is enabled.
  • 0: Disabled
  • 1: Enabled
enb_vm_pinIntegerWhether the voicemail PIN authentication is enabled.
  • 0: Disabled
  • 1: Enabled
vm_pinStringThe PIN code to access voicemail.
new_vm_notificationStringWhether the extension user will be notified when receiving a new voicemail message, 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_notificationStringHow to deal with the voicemail message after sending an email to notify the extension.
  • no: Keep the voicemail message in mailbox as unread.
  • mark_read: Keep the voicemail message in mailbox as read.
  • delete: Delete the voicemail message.
enb_vm_play_datetimeIntegerWhether to announce the message arrival time before playing the voicemail message.
  • 0: Disabled
  • 1: Enabled
vm_play_time_formatStringThe 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_endpointsInteger

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_endpointsIntegerWhether 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_modeStringDTMF mode.
  • rfc4733: RFC4733 (RFC2833)
  • info: Info
  • inband: Inband
  • auto: Auto
transportStringTransport protocol.
  • udp: UDP protocol
  • tcp: TCP protocol
  • tls: TLS protocol
enb_qualifyIntegerWhether the Qualify is enabled.
  • 0: Disabled
  • 1: Enabled
enb_t38_supportIntegerWhether the T.38 fax is enabled.
  • 0: Disabled
  • 1: Enabled
enb_natIntegerWhether the NAT is enabled.
  • 0: Disabled
  • 1: Enabled
enb_srtpIntegerWhether the SRTP is enabled.
  • 0: Disabled
  • 1: Enabled
allow_reg_remotelyIntegerWhether the remote registration is enabled.
  • 0: Disabled
  • 1: Enabled
disable_outb_callIntegerWhether outbound call is allowed.
  • 0: Allow to make outbound calls.
  • 1: NOT allowed to make outbound calls.
disable_outb_call_outside_business_hoursInteger

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_callIntegerWhether international call is allowed.
  • 0: Allow to make international calls.
  • 1: NOT allowed to make international calls.
max_outb_call_durationIntegerThe 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_permissionArray <Integer>The unique ID(s) of outbound route(s) that the extension is allowed to use.
enb_mobile_clientIntegerWhether the Simu Connect Mobile Client is enabled.
  • 0: Disabled
  • 1: Enabled
enb_web_clientIntegerWhether the Simu Connect Web Client is enabled.
  • 0: Disabled
  • 1: Enabled
enb_desktop_clientIntegerWhether the Simu Connect Desktop Client is enabled.
  • 0: Disabled
  • 1: Enabled
enb_pad_clientIntegerWhether the Simu Connect Pad Client (SDK) is enabled.
  • 0: Disabled
  • 1: Enabled
enb_internal_clientIntegerReserved.
simuconnect_mobile_codecStringCodec for Simu Connect Mobile Client.
  • ulaw
  • alaw
  • ilbc
  • g722
  • g729
  • opus
enb_iceStringWhether ICE (Interactive Connectivity Establishment) is enabled for Simu Connect Mobile Client.
  • yes: ICE enabled.
  • no: ICE disabled.
client_conf_listArray <Simu Connect_Clients_Setting>The list of the Simu Connect Clients settings.
mohString

The name of the MoH (Music on Hold) playlist whose audio is played when the extension user places a call on hold.

call_forward_mohString

The name of the MoH (Music on Hold) playlist whose audio is played for the caller when the call is forwarded to another destination.

ringback_tone_mohStringThe filename of custom prompt played for the caller before the extension user answers the call.
vm_greetingStringThe filename of the voicemail greeting.

Organization_Info

ParameterTypeDescription
textStringThe name of the organization to which the extension belongs.
valueStringThe unique ID of the organization.

Presence_Setting

ParameterTypeDescription
statusStringExtension 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_forwardIntegerWhether internal incoming calls will always be forwarded to a specific destination (Always condition).
  • 0: Disabled
  • 1: Enabled
in_always_forward_destStringThe 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_prefixStringThe 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_valueStringThe 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_numStringThe external number of the external_num destination for internal call forwarding in Always condition.
enb_in_no_answer_forwardIntegerWhether 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_destStringThe 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_prefixStringThe 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_valueStringThe 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_numStringThe external number of the external_num destination for internal call forwarding in No Answer condition.
enb_in_busy_forwardIntegerWhether internal incoming calls will be forwarded to a specific destination when the extension is busy (Busy condition).
  • 0: Disabled
  • 1: Enabled
in_busy_forward_destStringThe destination type for internal call forwarding in 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_prefixStringThe parameter returns different values depending on the destination type for internal call forwarding in 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_valueStringThe destination for internal call forwarding in 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_numStringThe external number of the external_num destination for internal call forwarding in Busy condition.
enb_ex_always_forwardIntegerWhether external incoming calls will always be forwarded to a specific destination (Always condition).
  • 0: Disabled
  • 1: Enabled
ex_always_forward_destStringThe 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_prefixStringThe 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_valueStringThe 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_numStringThe external number of the external_num destination for external call forwarding in Always condition.
enb_ex_no_answer_forwardIntegerWhether 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_destStringThe 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_prefixStringThe 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_valueStringThe 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_numStringThe external number of the external_num destination for external call forwarding in No Answer condition.
enb_ex_busy_forwardIntegerWhether external incoming calls will be forwarded to a specific destination when the extension is busy (Busy condition).
ex_busy_forward_destStringThe destination type for external call forwarding in 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_prefixStringThe parameter returns different values depending on the destination type for external call forwarding in 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_valueStringThe destination for external call forwarding in 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_numStringThe external number of the external_num destination for external call forwarding in Busy condition.
ring_timeoutIntegerThe ringing timeout for incoming calls (Unit: Second).
enb_ring_mobileIntegerWhether the mobile phone will ring simultaneously when the extension rings.
  • 0: Disabled
  • 1: Enabled
mobile_prefixStringThe dial-out prefix of the mobile number for the "Ring the Mobile Number Simultaneously" feature.
mobile_numberStringMobile number.
enb_accept_call_from_rgInteger

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

  • 0: Disabled
  • 1: Enabled
vm_greetingStringThe filename of the voicemail greeting.

Simu_Connect_Clients_Setting

ParameterTypeDescription
idIntegerSimu Connect Client ID.
clientStringSimu Connect Client type.
  • simuconnectmobile: Simu Connect Mobile Client
  • simuconnectdesktop: Simu Connect Desktop Client
  • simuconnectweb: Simu Connect Web Client
enb_call_waitingIntegerWhether a second call can be received while the extension is already on the phone.
  • 0: Disabled
  • 1: Enabled
enb_auto_answerIntegerWhether non-paging/intercom calls to the extension will be automatically answered.
  • 0: Disabled
  • 1: Enabled
auto_answer_delay_timeIntegerThe 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_toneIntegerWhether 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_pagingIntegerWhether paging/intercom calls to the extension will be automatically answered.
  • 0: Disabled
  • 1: Enabled
enb_auto_answer_paging_bargeIntegerWhether 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_toneIntegerWhether a tone will be played to alert the extension when a paging/intercom call is automatically answered.
  • 0: Disabled
  • 1: Enabled
call_pop_switchIntegerWhether automatic call popup will be triggered to display customer data when the extension receives an incoming call.
  • 0: Disabled
  • 1: Enabled
open_contact_urlStringThe third-party URL for the call popup.
notify_whenStringWhen 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_listArray<String>Which types of calls will trigger the call popup.
  • internal: Internal calls from colleagues.
  • inbound: Inbound calls from external users.
max_clientsIntegerThe maximum number of Simu Connect Clients that can be simultaneously logged in to the extension.
  • 1
  • 2
  • 3

Examples

Request example

Query the detailed information of extension (ID: 39).

GET /openapi/v1.0/extension/get?id=39&access_token=q0GyBcsgO8FsXWxPpzAJVW33vd0OpnUz 
Host: 192.168.5.150:8088

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,
"caller_id": "2000",
"title": "",
"reg_name": "2000",
"reg_password": "",
"concurrent_registrations": 1,
"type": "SIP",
"number": "2000",
"dtmf_mode": "rfc4733",
"enb_nat": 1,
"enb_qualify": 1,
"enb_srtp": 0,
"enb_t38_support": 0,
"transport": "udp",
"enb_vm": 1,
"enb_vm_pin": 1,
"vm_pin": "6666",
"vm_lang": "sound-zh",
"user_lang": "sound-en",
"new_vm_notification": "with_attach",
"vm_after_notification": "delete",
"allow_reg_remotely": 1,
"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": "vm_welcome.wav"
},
{
"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": "vm_away.wav"
},
{
"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": ""
},
{
"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": ""
},
{
"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": "vm_away.wav"
},
{
"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": "vm_holiday.wav"
}
],
"enb_all_reject_mode_for_endpoints": 1,
"simuconnect_mobile_codec": "g729",
"enb_ice": "no",
"client_conf_list": [
{
"id": 13,
"client": "simuconnectweb",
"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": "https://web/solve.360.com/{{.CallerNumber}}&{{.CallerDisplayName}}",
"notify_when": "ringing",
"communication_type_list": [
"inbound"
],
"max_clients": 1
},
{
"id": 14,
"client": "simuconnectdesktop",
"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": "simuconnectmobile",
"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": 2
}
],
"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": 0,
"avatar": "myYtwrWoRmxBeyGrd0ff1e60-2b53-4d17-8a13-736923dab108",
"moh": "SoftBreeze",
"call_forward_moh": "follow_system",
"ringback_tone_moh": "Welcome.wav",
"vm_greeting": "Artificial.wav"
}
}
Useful Links
  • Home
  • About us
  • Products
  • Services
  • Shipping
  • Return Policy
  • Warranty
  • Contact us
Legal
  • Terms
  • Privacy
  • Shared Responsibility
    Service Level Agreement
  • Certifications
About us

Cloud One Limited is a leading Kenyan local telephony service provider. Established in 2017, we offer reliable and secure cloud and on premise business communication solutions, including SIP trunks, Yealink IP phones, and VPS hosting in our Tier 3 data center.


Our mission is to revolutionize cloud communications by providing unparalleled reliability, cutting-edge innovation, and substantial cost savings. We deliver a stress-free, always-available service experience that empowers businesses to thrive in the digital age.

DUNS Registration Number: 561230946
Company Registration Number: PVT-5JUEYMA
Licensed & Regulated by the Communications Authority of Kenya


Follow us
Connect with us
  • Contact us
  • hello@cloudone.co
  • +254 20 7900000
  • Saachi Plaza, UNIT A3 - Argwings Kodhek Rd
Download Simu Connect

    Get the app on the playstore

    Download desktop app for Windows​

    Download app from the appstore

    Download MacOS app