Skip to content

Extension Parameters

When you export or bulk-import extensions, Cloud Voice stores each extension as one row in a CSV (comma-separated values) file. This page describes every column in that file: what it holds, whether it is required, the values it accepts, and the value applied when you leave it blank on import.

ColumnRequiredFormat and rulesDefault
First NameOne name requiredUser’s first name; up to 63 characters. At least one of First Name or Last Name must be supplied. If both are blank, First Name is set to the Extension Number.Extension Number
Last NameOne name requiredUser’s last name; up to 63 characters. At least one of First Name or Last Name must be supplied.None
Email AddressOptionalUser’s email address; up to 255 characters and unique across all extensions. Use only letters, numbers, and the characters @ _ - . '; it must start with a letter, number, or _ and follow the form XXX@XXX.XX.None
Mobile NumberOptionalUser’s mobile number; up to 31 characters. Letters, numbers, and the characters ( ) . - + * # are allowed.None
ColumnRequiredFormat and rulesDefault
User PasswordRequiredPassword for signing in to the Cloud Voice App and the management portal. Must combine uppercase letters, lowercase letters, and numbers. Cannot contain four consecutive digits, four identical digits, the extension number, the first name, or the last name.Auto-generated
User RoleRequiredManagement role granted to the user. Enter 0 for no role, or the name of a role defined in the system.0 (None)
OrganizationOptionalOrganization the user belongs to. Enter the full path from the root organization, joined with /; separate multiple organizations with &. See the examples below.Root organization (your Company Name)
System Prompt LanguageOptionalLanguage of the system prompts the user hears during calls. Enter follow_system or the name of a prompt language installed on the system (for example, German). If the language you enter is not installed, follow_system is used.follow_system
Email LanguageOptionalLanguage of the email notifications sent to the user. Enter follow_system or the name of an installed email language (for example, German). If the language is not installed, follow_system is used.follow_system

Write the value as the full path from the root organization down, separating each level with a forward slash (/). To place the user in more than one organization, list each full path and join them with an ampersand (&).

Suppose your root organization is named Acme:

  • To place the user in the root organization, enter Acme.
  • To place them in a first-level organization named “Marketing Center”, enter Acme/Marketing Center.
  • To place them in a second-level organization named “Support Team” beneath Marketing Center, enter Acme/Marketing Center/Support Team.
  • To place them in two organizations at once, enter Acme/Marketing Center&Acme/Product Management Center.
ColumnRequiredFormat and rulesDefault
Extension NumberRequiredThe extension’s number. Digits only, up to 11 characters, and unique across the system.None
Caller IDRequiredCaller ID shown on the called party’s device. Letters, numbers, and the characters ( ) . - + * # are allowed, up to 31 characters. If blank, the Extension Number is used.Extension Number
Emergency Outbound Caller IDOptionalCaller ID presented when the extension places an emergency call. Same character rules as Caller ID, up to 31 characters.None
Registration NameRequiredName used to authenticate SIP (Session Initiation Protocol, the signaling that registers and connects phones) registration; up to 63 characters.Auto-generated
Registration PasswordRequiredPassword used to register the SIP extension. Must combine uppercase, lowercase, and numbers, and cannot contain four consecutive digits, four identical digits, the extension number, the first name, or the last name.Auto-generated
IP Phone Concurrent RegistrationsRequiredNumber of SIP phones that may register to the extension at the same time. Enter 1, 2, 3, 4, or 5.1
Cloud Voice App (Web) Concurrent RegistrationsRequiredNumber of web sessions of the Cloud Voice App that may be signed in at once. Enter 1, 2, or 3.1
Cloud Voice App (Desktop) Concurrent RegistrationsRequiredNumber of desktop sessions of the Cloud Voice App that may be signed in at once. Enter 1, 2, or 3.1
Cloud Voice App (Mobile) Concurrent RegistrationsRequiredNumber of mobile sessions of the Cloud Voice App that may be signed in at once. Enter 1, 2, or 3.1
ColumnRequiredFormat and rulesDefault
Enable VoicemailRequiredTurn voicemail on or off. 0 = off, 1 = on.1
Voicemail PIN AuthenticationRequired when Enable Voicemail = 1Require a PIN to open the mailbox. 0 = off, 1 = on.1
Voicemail Access PINRequired when Enable Voicemail = 1 and Voicemail PIN Authentication = 1PIN for opening the mailbox. Digits only, 3 to 15 characters.Auto-generated
Voicemail LanguageOptionalLanguage of the prompts a caller hears when leaving a voicemail. Enter follow_system or an installed prompt language (for example, German); if it is not installed, follow_system is used.follow_system
New Voicemail NotificationRequired when Enable Voicemail = 1How the user is emailed about new voicemail. no = no email; with_attach = email with the recording attached; without_attach = email without the recording. If this column or Email Address is blank, no is used.no
Send toRequired when Enable Voicemail = 1 and New Voicemail Notification = with_attach or without_attachWhere notification emails are sent. user Email = the user’s own email address; custom Email = the address in Voicemail Email Address.user Email
Voicemail Email AddressRequired when Enable Voicemail = 1, New Voicemail Notification = with_attach or without_attach, and Send to = custom EmailCustom address for voicemail notifications. Up to 255 characters, using letters, numbers, and the characters @ _ - .; must start with a letter, number, or _ and follow the form XXX@XXX.XX.None
After NotificationRequired when Enable Voicemail = 1 and New Voicemail Notification = with_attach or without_attachWhat to do with the mailbox copy once the notification is sent. no = leave it; mark_read = mark it read; delete = delete it. delete is available only when New Voicemail Notification = with_attach.no
Play Date and TimeRequired when Enable Voicemail = 1Announce when the message was left before playing it. 0 = off, 1 = on.0
Time Display FormatRequired when Play Date and Time = 1Clock format for the announced time. Follow System, 12-hour format, or 24-hour format.Follow System
Play Caller IDRequired when Enable Voicemail = 1Announce the caller’s ID before playing the message. 0 = off, 1 = on.0
Play Message DurationRequired when Enable Voicemail = 1Announce the message length in minutes before playing it. 0 = off, 1 = on.0
ColumnRequiredFormat and rulesDefault
Send email notification when the User Password is changedRequiredEmail the user when their sign-in password changes. 0 = off, 1 = on.1
Send email notifications on missed callsRequiredEmail the user when they miss a call. 0 = off, 1 = on.0
Allow Being MonitoredRequiredLet supervisors monitor this user’s calls. 0 = off, 1 = on.1
Monitor Call QualityOptionalCollect call-quality data for this extension. 0 = off, 1 = on.0
Monitoring End DateRequired when Monitor Call Quality = 1When call-quality monitoring stops. Use the format DD/MM/YYYY HH:MM:SS, for example 25/10/2020 23:59:59.None
ColumnRequiredFormat and rulesDefault
Recording operationRequiredWhether the user can change their own recording state during a call. 0 = not allowed; 1 = pause and resume; 2 = start, pause, and resume.0
All Busy Mode for EndpointsRequiredSend a new call to the Busy destination when any one of the extension’s registered endpoints is already on a call. 0 = off, 1 = on.0
All Reject Mode for EndpointsRequiredWhen a call is rejected on one endpoint, stop ringing the others and send it to the Busy destination. 0 = off, 1 = on.0
Video PreviewOptionalLet other users press a button to preview this extension’s video on an incoming call from it. 0 = off, 1 = on.0
Auto PreviewOptionalAutomatically show other users this extension’s video on an incoming call from it. 0 = off, 1 = on.0
ColumnRequiredFormat and rulesDefault
Hot DeskingOptionalLet the extension sign in to a hot-desking phone. 0 = off, 1 = on.0
Log out of QueueOptionalAutomatically remove the user as a dynamic agent from their queues when they sign out of a hot-desking phone. 0 = off, 1 = on.0
Automatic Guest OutOptionalAutomatically sign the extension out of a hot-desking phone. 0 = never; 1 = after a set delay; 2 = at a set time each day.0
After hr.Required when Automatic Guest Out = 1Hours in the sign-out delay. Enter 00 to 23.08
After min.Required when Automatic Guest Out = 1Minutes in the sign-out delay. Enter 00 to 59.00
At DailyRequired when Automatic Guest Out = 2Daily sign-out time in HH:MM format, for example 13:30. The end time must be later than the start time.None
ColumnRequiredFormat and rulesDefault
DTMF ModeRequiredHow DTMF (dual-tone multi-frequency, the tones a phone sends when its keypad keys are pressed) tones are sent. rfc4733, info, inband, or auto.rfc4733
TransportRequiredTransport protocol(s) for the extension. One or more of udp, tcp, tls.udp
QualifyRequiredPeriodically send a SIP OPTIONS packet to check that the device is reachable. 0 = off, 1 = on.1
T.38 SupportRequiredSupport T.38 fax on this extension. 0 = off, 1 = on.0
SRTPRequiredEncrypt the call’s media (audio and video) stream. SRTP stands for Secure RTP (Real-time Transport Protocol), the protocol that carries the media. 0 = off, 1 = on.0
ColumnRequiredFormat and rulesDefault
Disable Outbound CallsRequiredBlock the user from placing outbound calls. 0 = off, 1 = on.0
Disable Outbound Calls outside Business HoursRequiredBlock outbound calls outside business hours. 0 = off, 1 = on.0
Disallow International CallsRequiredBlock international calls. 0 = off, 1 = on.1
Outbound Route PermissionOptionalOutbound routes this extension may use. Enter existing outbound route names, separated by & (for example, {name1}&{name2}). Names that do not exist are skipped.None
Max Outbound Call Duration (s)RequiredLongest outbound call, in seconds. Digits only, up to 7 characters. -1 follows the system setting; 0 means unlimited.-1
Outbound Call Frequency RestrictionOptionalFrequency-limit rule(s) applied to the extension’s outbound calls. Enter existing rule names, separated by &. Names that do not exist are skipped.Default_Ext_Outbound Call Frequency

These columns control which Cloud Voice App platforms the user can sign in to, and the media codec for the mobile app.

ColumnRequiredFormat and rulesDefault
Cloud Voice App (Mobile)RequiredLet the user sign in to the Cloud Voice App on mobile. 0 = off, 1 = on.1
Cloud Voice App (Desktop)RequiredLet the user sign in to the Cloud Voice App on desktop. 0 = off, 1 = on.1
Cloud Voice App (Web)RequiredLet the user sign in to the Cloud Voice App in a web browser. 0 = off, 1 = on.1
Cloud Voice App (Pad, SDK)RequiredLet the user sign in to the SDK-based pad client. 0 = off, 1 = on. Takes effect only when the SDK is enabled (Integrations > Cloud Voice App SDK).1
Cloud Voice App (Mobile) CodecOptionalAudio codec for the mobile app. One of ulaw, alaw, ilbc, g722, g729, opus.None

Each setting below exists three times in the CSV, once for mobile, once for desktop, and once for web. The platform appears in the column name, for example Call Waiting (Mobile), Call Waiting (Desktop), and Call Waiting (Web). The requirement, accepted values, and defaults are the same on every platform.

SettingRequiredFormat and rulesDefault
Call WaitingOptionalAllow a second call while the user is already on a call. 0 = off, 1 = on.1
Auto AnswerRequiredAutomatically answer ordinary (non-paging/intercom) calls. 0 = off, 1 = on.0
Auto Answer Delay Time (s)Required when Auto Answer = 1Seconds to wait before auto-answering an ordinary call. Digits only, up to 60.0
Play Auto Answer ToneOptionalPlay a tone to alert the user when an ordinary call is auto-answered. 0 = off, 1 = on.1
Auto Answer Paging/Intercom CallRequiredAutomatically answer paging and intercom calls. 0 = off, 1 = on.0
Paging/Intercom BargeOptionalAutomatically answer a paging/intercom call even when the user is already on a call. 0 = off, 1 = on.0
Play Auto Answer Tone for Paging/Intercom CallOptionalPlay a tone to alert the user when a paging/intercom call is auto-answered. 0 = off, 1 = on.1