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
  • ​​

Add an Extension

Add and configure a SIP extension.

Request URL

POST {base_url}/{api_path}/extension/create?access_token={access_token}

Request parameters

ParameterRequiredTypeDescription
typeYesStringExtension type.

Valid value: SIP

avatarNoStringThe file ID of the extension's avatar.Note:
  • You need to first upload the avatar file to the PBX, then pass the returned file ID in this parameter.
  • If this parameter is omitted, the extension will use the system default avatar.
first_nameNoStringFirst name.
last_nameNoStringLast name.
email_addrNoStringEmail address.
mobile_numberNoStringMobile number.
user_passwordYesStringUser password.Note:
  • Must contain numbers, uppercase, and lowercase letters.
role_idNoIntegerThe ID of a user role.
Note:You can query user role's ID using Get Menu Options.
organization_listNoArray <Organization_Info>The organization(s) to which the extension belongs.Note:This parameter is required if the Organization Management feature is enabled.
titleNoStringThe job title of the extension user.
email_languageNoStriingThe language of email notifications for the extension.

Valid value:

  • 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_langNoStringThe language of the system prompts heard by the extension during a call.Valid value: follow_system or one of the prompt language existed in PBX System Prompt (e.g. German).Note:You can query the available system prompts using Get Menu Options.
vm_langNoStringThe language of the system prompts heard by caller when they access the extension's voicemail box.

Valid value: follow_system or one of the prompt language existed in PBX System Prompt (e.g. German).

Note:You can query the available system prompts using Get Menu Options.
numberYesStringExtension number.Note:
  • Only numbers are allowed.
  • The maximum character length is 11.
caller_idNoStringCaller ID.Note:
  • Numbers, letters, and special characters ( ) . - + * # are allowed.
  • The maximum character length is 31.
reg_nameYesStringRegistration name.Note:The maximum character length is 63.
reg_passwordYesStringRegistration password.
concurrent_registrationsYesIntegerIP phone concurrent registrations.Valid value:
  • 1 (default)
  • 2
  • 3
  • 4
  • 5
presence_statusYesStringThe current presence status of the extension.

Valid value:

  • available: Available
  • away: Away
  • business_trip: Business Trip
  • do_not_disturb: Do Not Disturb (DND)
  • lunch: Lunch Break
  • off_work: Off Work
presence_listNoArray <Presence_Setting>The list of the presence settings.
presence_mobile_prefixNoStringThe dial-out prefix of the mobile number for the "Ring the Mobile Number Simultaneously" feature.
agent_idNoString

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.

Note:Agent ID will be announced when Agent ID Announcement is enabled for queues on PBX web portal (Path: Call Features > Queue > Preferences > Announcement).
enb_vmNoIntegerWhether to enable the voicemail.

Valid value:

  • 0: Disable
  • 1: Enable
enb_vm_pinNoIntegerWhether to enable the voicemail PIN authentication.

Valid value:

  • 0: Disable
  • 1: Enable
vm_pinNoStringThe PIN code to access voicemail.
new_vm_notificationNoStringWhether to notify the extension when receiving a new voicemail message, and how to notify.

Valid value:

  • 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_notificationNoStringHow to deal with the voicemail message after sending an email to notify the extension.

Valid value:

  • no: Keep the voicemail message in mailbox as unread.
  • mark_read: Keep the voicemail message in mailbox as read.
  • delete: Delete the voicemail message.Note:This value is supported only when new_vm_notification is set to with_attach.
enb_vm_play_datetimeNoIntegerWhether to announce the message arrival time before playing the voicemail message.
  • 0: Disabled
  • 1: Enabled
vm_play_time_formatNoStringSpecify the time format for announcing the message arrival time.

Valid value:

  • 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_endpointsNoInteger

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

Valid value:

  • 0: Disabled
  • 1: Enabled
enb_all_reject_mode_for_endpointsNoIntegerWhether to stop ringing other endpoints when an incoming call is rejected on one of the endpoints (with the extension registered).

Valid value:

  • 0: Disable. When an incoming call is rejected on one endpoint, other endpoints still ring.
  • 1: Enable. When an incoming call is rejected on one endpoint, other endpoints stop ringing.
dtmf_modeNoStringDTMF mode.

Valid value:

  • rfc4733: RFC4733 (RFC2833)
  • info: Info
  • inband: Inband
  • auto: Auto
transportNoStringTransport protocol(s).

Valid value:

  • udp: UDP protocol
  • tcp: TCP protocol
  • tls: TLS protocol
  • Use commas to separate multiple protocols. For example, udp,tcp,tls; if this parameter is omitted, the default protocol is udp.
  • tcp is available only when the SIP TCP Port is enabled (Path: PBX Settings > SIP Settings > General > Basic); while tls is available only when the TLS is enabled (Path: PBX Settings > SIP Settings > TLS).
  • When multiple protocols are selected, the following priority rules are applied:

    • Simu Connect UC Clients / Auto-provisioned IP phones: TLS > TCP > UDP
    • Manually registered IP phones: Uses the phone's specified protocol if available; if not specified, follows the default priority (TLS > TCP > UDP).
Note:
enb_qualifyNoIntegerWhether to enable Qualify.

Valid value:

  • 0: Disable
  • 1: Enable
enb_t38_supportNoIntegerWhether to support T.38 fax.

Valid value:

  • 0: Disable
  • 1: Enable
enb_natNoIntegerWhether to enable NAT.

Valid value:

  • 0: Disable
  • 1: Enable
enb_srtpNoIntegerWhether to enable SRTP.

Valid value:

  • 0: Disable
  • 1: Enable
allow_reg_remotelyNoIntegerWhether to enable remote registration.

Valid value:

  • 0: Disable
  • 1: Enable
disable_outb_callNoIntegerWhether to restrict the extension from making outbound calls.

Valid value:

  • 0: Allow to make outbound calls.
  • 1: NOT allowed to make outbound calls.
disable_outb_call_outside_business_hoursNoIntegerWhether to restrict the extension from making outbound calls outside Business Hours.

Valid value:

  • 0: Allow to make outbound calls outside Business Hours.
  • 1: NOT allowed to make outbound calls outside Business Hours.
disable_international_callNoIntegerWhether to restrict the extension from making international calls.

Valid value:

  • 0: Allow to make international calls.
  • 1: NOT allowed to make international calls.
max_outb_call_durationNoIntegerSpecify the maximum call duration of an outbound call made from the extension.

Valid value:

  • -1: Follow system setting (Set on PBX Settings > Preferences > Max Call Duration (s)).
  • 0: Unlimited.
  • Other value: The maximum call duration in seconds (1 - 9999999).
outbound_route_permissionNoArray <Integer>The unique ID(s) of outbound route(s) that the extension is allowed to use.Note:
  • You can query outbound route's ID using Search Specific Outbound Routes.
  • Use a comma to separate multiple IDs.
enb_mobile_clientNoIntegerWhether to enable Simu Connect Mobile Client.

Valid value:

  • 0: Disable
  • 1: Enable
enb_desktop_clientNoIntegerWhether to enable Simu Connect Desktop Client.

Valid value:

  • 0: Disable
  • 1: Enable
enb_web_clientNoIntegerWhether to enable Simu Connect Web Client.

Valid value:

  • 0: Disable
  • 1: Enable
enb_pad_clientNoIntegerWhether to enable Simu Connect Pad Client (SDK).

Valid value:

  • 0: Disable
  • 1: Enable
Note:This option takes effect ONLY when you have integrated the Simu Connect SDK for Android or Simu Connect SDK for iOS.
simuconnect_mobile_codecNoString

Set codec for Simu Connect Mobile Client.

Valid value:

  • ulaw
  • alaw
  • ilbc
  • g722
  • g729
  • opus
enb_iceNoString

Whether to enable ICE (Interactive Connectivity Establishment) for Simu Connect Mobile Client.

Valid value:

  • yes: Enable ICE.
  • no: Disable ICE.
client_conf_listNoArray <Simu Connect_Clients_Setting>The list of the Simu Connect Clients settings.
mohNoString

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

Note:You can query the name of MoH playlists using Query MoH Playlists.
call_forward_mohNoString

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

Note:You can query the name of MoH playlists using Query MoH Playlists.
ringback_tone_mohNoString

The filename of custom prompt (e.g. demo.wav) played for the caller before the extension user answers the call.

Note:You can query the available custom prompts using Get Menu Options ("menu":"custom_prompt").
vm_greetingNoString

The filename of the voicemail greeting (e.g. demo.wav).

Note:You can query the filename of voicemail greetings using Query Extension Voicemail Greeting List.

Organization_Info

ParameterRequiredTypeDescription
valueYesStringThe unique ID of an organization.
Note:You can query organization's ID using Get Menu Options.

Presence_Setting

ParameterRequiredTypeDescription
statusYesStringExtension presence.

Valid value:

  • 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_forwardNoIntegerWhether to always forward internal incoming calls to a specific destination (Always condition).

Valid value:

  • 0: Disable
  • 1: Enable
in_always_forward_destNoStringThe destination type for internal call forwarding in Always condition.

Valid value:

  • 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.
Note:When the destination type is ext_vm or mobile_number, the system will automatically retrieve the corresponding destination value from the extension information.
in_always_forward_prefixNoStringThe parameter defines different settings depending on the destination type for internal call forwarding in Always condition.
  • When the destination type is mobile_number or external_num, the parameter defines the dial-out prefix of the external destination number.
  • When the destination type is play_greeting, the parameter defines the play count of the greeting. The valid value is 1 - 5.
in_always_forward_valueNoStringThe destination for internal call forwarding in Always condition.

This parameter is REQUIRED for the following destination types:

  • When the destination type is play_greeting, this parameter defines the custom prompt file name. E.g. demo.wav.
  • When the destination type is extension, ivr, ring_group, queue, or group_vm, this parameter should be the unique ID of the destination.For example, the destination is the extension 2002, then this parameter should be set to the extension's ID 2.Note:

    • You can query the extension ID using Search Specific Extensions.
    • You can query the ID of other destination options using Get Menu Options.
in_always_forward_numNoStringThe external number of the external_num destination for internal call forwarding in Always condition.
enb_in_no_answer_forwardNoIntegerWhether to forward internal calls to a specific destination when the calls are not answered (No Answer condition).

Valid value:

  • 0: Disable
  • 1: Enable
in_no_answer_forward_destNoStringThe destination type for internal call forwarding in No Answer condition.

Valid value:

  • 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.
Note:When the destination type is ext_vm or mobile_number, the system will automatically retrieve the corresponding destination value from the extension information.
in_no_answer_forward_prefixNoStringThe parameter defines different settings 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 defines the dial-out prefix of the external destination number.
  • When the destination type is play_greeting, the parameter defines the play count of the greeting. The valid value is 1 - 5.
in_no_answer_forward_valueNoStringThe destination for internal call forwarding in No Answer condition.

This parameter is REQUIRED for the following destination types:

  • When the destination type is play_greeting, this parameter defines the custom prompt file name. E.g. demo.wav.
  • When the destination type is extension, ivr, ring_group, queue, or group_vm, this parameter should be the unique ID of the destination.For example, the destination is the extension 2002, then this parameter should be set to the extension's ID 2.Note:

    • You can query the extension ID using Search Specific Extensions.
    • You can query the ID of other destination options using Get Menu Options.
in_no_answer_forward_numNoStringThe external number of the external_num destination for internal call forwarding in No Answer condition.
enb_in_busy_forwardNoIntegerWhether to forward internal calls to a specific destination when the extension is busy (Busy condition).

Valid value:

  • 0: Disable
  • 1: Enable
in_busy_forward_destNoStringThe destination type for internal call forwarding in Busy condition.

Valid value:

  • 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.
Note:When the destination type is ext_vm or mobile_number, the system will automatically retrieve the corresponding destination value from the extension information.
in_busy_forward_prefixNoStringThe parameter defines different settings depending on the destination type for internal call forwarding in Busy condition.
  • When the destination type is mobile_number or external_num, the parameter defines the dial-out prefix of the external destination number.
  • When the destination type is play_greeting, the parameter defines the play count of the greeting. The valid value is 1 - 5.
in_busy_forward_valueNoStringThe destination for internal call forwarding in Busy condition.

This parameter is REQUIRED for the following destination types:

  • When the destination type is play_greeting, this parameter defines the custom prompt file name. E.g. demo.wav.
  • When the destination type is extension, ivr, ring_group, queue, or group_vm, this parameter should be the unique ID of the destination.For example, the destination is the extension 2002, then this parameter should be set to the extension's ID 2.Note:

    • You can query the extension ID using Search Specific Extensions.
    • You can query the ID of other destination options using Get Menu Options.
in_busy_forward_numNoStringThe external number of the external_num destination for internal call forwarding in Busy condition.
enb_ex_always_forwardNoIntegerWhether to always forward external calls to a specific destination (Always condition).

Valid value:

  • 0: Disable
  • 1: Enable
ex_always_forward_destNoStringThe destination type for external call forwarding in Always condition.

Valid value:

  • 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.
Note:When the destination type is ext_vm or mobile_number, the system will automatically retrieve the corresponding destination value from the extension information.
ex_always_forward_prefixNoStringThe parameter defines different settings depending on the destination type for external call forwarding in Always condition.
  • When the destination type is mobile_number or external_num, the parameter defines the dial-out prefix of the external destination number.
  • When the destination type is play_greeting, the parameter defines the play count of the greeting. The valid value is 1 - 5.
ex_always_forward_valueNoStringThe destination for external call forwarding in Always condition.

This parameter is REQUIRED for the following destination types:

  • When the destination type is play_greeting, this parameter defines the custom prompt file name. E.g. demo.wav.
  • When the destination type is extension, ivr, ring_group, queue, or group_vm, this parameter should be the unique ID of the destination.For example, the destination is the extension 2002, then this parameter should be set to the extension's ID 2.Note:

    • You can query the extension ID using Search Specific Extensions.
    • You can query the ID of other destination options using Get Menu Options.
ex_always_forward_numNoStringThe external number of the external_num destination for external call forwarding in Always condition.
enb_ex_no_answer_forwardNoIntegerWhether to forward external calls to a specific destination when the calls are not answered (No Answer condition).

Valid value:

  • 0: Disable
  • 1: Enable
ex_no_answer_forward_destNoStringThe destination type for external call forwarding in No Answer condition.

Valid value:

  • 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.
Note:When the destination type is ext_vm or mobile_number, the system will automatically retrieve the corresponding destination value from the extension information.
ex_no_answer_forward_prefixNoStringThe parameter defines different settings 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 defines the dial-out prefix of the external destination number.
  • When the destination type is play_greeting, the parameter defines the play count of the greeting. The valid value is 1 - 5.
ex_no_answer_forward_valueNoStringThe destination for external call forwarding in No Answer condition.

This parameter is REQUIRED for the following destination types:

  • When the destination type is play_greeting, this parameter defines the custom prompt file name. E.g. demo.wav.
  • When the destination type is extension, ivr, ring_group, queue, or group_vm, this parameter should be the unique ID of the destination.For example, the destination is the extension 2002, then this parameter should be set to the extension's ID 2.Note:

    • You can query the extension ID using Search Specific Extensions.
    • You can query the ID of other destination options using Get Menu Options.
ex_no_answer_forward_numNoStringThe external number of the external_num destination for external call forwarding in No Answer condition.
enb_ex_busy_forwardNoIntegerWhether to forward external calls to a specific destination when the extension is busy (Busy condition).

Valid value:

  • 0: Disable
  • 1: Enable
ex_busy_forward_destNoStringThe destination type for external call forwarding in Busy condition.

Valid value:

  • 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.
Note:When the destination type is ext_vm or mobile_number, the system will automatically retrieve the corresponding destination value from the extension information.
ex_busy_forward_prefixNoStringThe parameter defines different settings depending on the destination type for external call forwarding in Busy condition.
  • When the destination type is mobile_number or external_num, the parameter defines the dial-out prefix of the external destination number.
  • When the destination type is play_greeting, the parameter defines the play count of the greeting. The valid value is 1 - 5.
ex_busy_forward_valueNoStringThe destination for external call forwarding in Busy condition.

This parameter is REQUIRED for the following destination types:

  • When the destination type is play_greeting, this parameter defines the custom prompt file name. E.g. demo.wav.
  • When the destination type is extension, ivr, ring_group, queue, or group_vm, this parameter should be the unique ID of the destination.For example, the destination is the extension 2002, then this parameter should be set to the extension's ID 2.Note:

    • You can query the extension ID using Search Specific Extensions.
    • You can query the ID of other destination options using Get Menu Options.
ex_busy_forward_numNoStringThe external number of the external_num destination for external call forwarding in Busy condition.
ring_timeoutYesIntegerThe ringing timeout for incoming calls (Unit: Second).

Valid value: 5 - 300

enb_ring_mobileNoIntegerWhether the mobile phone will ring simultaneously when the extension rings.

Valid value:

  • 0: Disable
  • 1: Enable
enb_accept_call_from_rgNoInteger

Whether to accept incoming calls from ring group when the extension is in specific presence status.

Valid value:

  • 0: Disable
  • 1: Enable
vm_greetingNoString

The filename of the voicemail greeting (e.g. demo.wav).

Note:You can query the filename of voicemail greetings using Query Extension Voicemail Greeting List.

SimuConnect_Clients_Setting

ParameterRequiredTypeDescription
clientYesStringThe type of Simu Connect Client for which you want to configure features such as call waiting, auto-answer for paging/intercom calls, or auto-answer for non-paging/intercom calls.

Valid value:

  • simuconnectmobile: Simu Connect Mobile Client
  • simuconnectdesktop: Simu Connect Desktop Client
  • simuconnectweb: Simu Connect Web Client
enb_call_waitingNoIntegerWhether to allow the extension to receive another call while already on the phone.

Valid value:

  • 0: Disabled
  • 1: Enabled
enb_auto_answerNoInteger

Whether to automatically answer non-paging/intercom calls.

Valid value:

  • 0: Disabled
  • 1: Enabled
auto_answer_delay_timeNoInteger

The delay time before automatically answering non-paging/intercom calls (Unit: Second).

Valid value: 0 - 60Note:0 indicates that incoming non-paging/intercom calls will be auto-answered immediately.
enb_auto_answer_toneNoInteger

Whether to alert the extension with a tone when a non-paging/intercom call is automatically answered.

Valid value:

  • 0: Disabled
  • 1: Enabled
enb_auto_answer_pagingNoIntegerWhether to automatically answer paging/intercom calls.

Valid value:

  • 0: Disabled
  • 1: Enabled
enb_auto_answer_paging_bargeNoIntegerWhether to automatically answer paging/intercom calls during an active call.

Valid value:

  • 0: Disabled
  • 1: Enabled
enb_auto_answer_paging_toneNoIntegerWhether to alert the extension with a tone when a paging/intercom call is automatically answered.

Valid value:

  • 0: Disabled
  • 1: Enabled
max_clientsYesIntegerThe maximum number of Simu Connect Clients that can be simultaneously logged in to the extension.Valid value:
  • 1
  • 2
  • 3

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.
idIntegerThe unique ID of the extension.

Examples

Request example

POST /openapi/v1.0/extension/create?access_token=q0GyBcsgO8FsXWxPpzAJVW33vd0OpnUz 
Host: 192.168.5.150:8088
Content-Type: application/json
{
"type": "SIP",
"avatar":"myYtwrWoRmxBeyGrd0ff1e60-2b53-4d17-8a13-736923dab108",
"first_name": "Terrell",
"last_name": "Smith",
"email_addr": "terrell@sample.com",
"mobile_number": "15880987652",
"user_password": "Userpwd1011",
"organization_list":[{"value":"1"},{"value":"2"}],
"role_id": 1,
"email_language":"en",
"user_lang": "sound-en",
"vm_lang":"follow_system",
"number": "1000",
"caller_id": "5503301",
"reg_name": "Cloud_One_ext",
"reg_password": "Regpwd1011",
"concurrent_registrations": 1,
"presence_status": "available",
"enb_all_reject_mode_for_endpoints":1,
"dtmf_mode": "rfc4733",
"transport": "udp",
"allow_reg_remotely": 0,
"agent_id":"5630",
"enb_vm":1,
"enb_vm_pin":1,
"vm_pin":"8573",
"new_vm_notification":"with_attach",
"vm_after_notification":"delete",
"enb_vm_play_datetime": 0,
"vm_play_time_format": "follow_system",
"enb_all_busy_mode_for_endpoints": 1,
"enb_all_reject_mode_for_endpoints":0,
"disable_international_call":1,
"disable_outb_call_outside_business_hours":1,
"disable_outb_call":0,
"max_outb_call_duration": -1,
"outbound_route_permission":[69],
"enb_mobile_client":1,
"enb_desktop_client":1,
"enb_web_client":1,
"enb_pad_client": 1,
"simuconnect_mobile_codec": "g729",
"enb_ice":"yes",
"presence_mobile_prefix": "86",
"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": "external_num",
"in_no_answer_forward_prefix": "",
"in_no_answer_forward_value": "",
"in_no_answer_forward_num": "123123",
"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,
"ring_timeout": 30,
"enb_accept_call_from_rg": 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": "1",
"ex_busy_forward_value": "demo.wav",
"ex_busy_forward_num": "",
"enb_ring_mobile": 0,
"ring_timeout": 30,
"enb_accept_call_from_rg": 0
},
{
"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,
"ring_timeout": 30,
"enb_accept_call_from_rg": 0
},
{
"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,
"ring_timeout": 30,
"enb_accept_call_from_rg": 0
},
{
"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": 1,
"ring_timeout": 30,
"enb_accept_call_from_rg": 0
},
{
"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,
"ring_timeout": 30,
"enb_accept_call_from_rg": 0
}
],
"client_conf_list": [
{
"client": "simuconnectweb",
"enb_call_waiting": 1,
"enb_auto_answer": 0,
"enb_auto_answer_paging": 1,
"enb_auto_answer_paging_barge": 0,
"enb_auto_answer_paging_tone": 1,
"max_clients": 2
},
{
"client": "simuconnectdesktop",
"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,
"max_clients": 2
},
{
"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,
"max_clients": 3
}
]
}
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