Bulk Import
From VoIP.ms Wiki
| [checked revision] | [checked revision] |
(→Step 3 — Import Sub Accounts from CSV) |
|||
| (2 intermediate revisions not shown) | |||
| Line 1: | Line 1: | ||
| - | = | + | {| cellspacing="0" style="width: 100%; background: linear-gradient(135deg, #f8fafc 0%, #f1f5f9 100%); border: 1px solid #e2e8f0; border-radius: 8px; padding: 35px; margin-bottom: 25px; box-shadow: 0 1px 3px rgba(0,0,0,0.05);" |
| + | |- | ||
| + | | style="text-align: center;" | | ||
| - | = | + | <div style="font-size: 2.8em; font-weight: 200; color: #1e293b; margin-bottom: 15px; letter-spacing: -2px;">Bulk Import</div> |
| - | + | ||
| - | + | ||
| - | = | + | <div style="font-size: 1rem; color: #64748b; margin-bottom: 15px;"> |
| + | Import multiple sub-accounts or voicemail boxes at once using CSV files. | ||
| + | </div> | ||
| - | : From your VoIP.ms portal: | + | |} |
| - | + | ||
| - | + | __TOC__ | |
| - | + | ||
| + | = Importing Sub-Accounts = | ||
| + | |||
| + | == Step 1 — Navigate to the Import Sub-Account Page == | ||
| + | |||
| + | {| cellspacing="0" style="width: 100%; background: white; border: 1px solid #e2e8f0; border-radius: 12px; padding: 25px; margin: 20px 0; box-shadow: 0 2px 10px rgba(0,0,0,0.06);" | ||
| + | |- | ||
| + | | style="vertical-align: top;" | | ||
| + | |||
| + | From your VoIP.ms portal: | ||
| + | # Go to '''Sub-Account''' in the menu | ||
| + | # Click '''Manage Sub Account''' | ||
| + | |||
| + | [[File:Bulk_Import_SubAccount_ManageSubAccount.png|none|500px]] | ||
| + | |||
| + | |} | ||
| + | |||
| + | == Step 2 — Open the Import Sub-Account Tool == | ||
| + | |||
| + | {| cellspacing="0" style="width: 100%; background: white; border: 1px solid #e2e8f0; border-radius: 12px; padding: 25px; margin: 20px 0; box-shadow: 0 2px 10px rgba(0,0,0,0.06);" | ||
| + | |- | ||
| + | | style="vertical-align: top;" | | ||
| - | |||
On the '''Manage Sub Accounts''' page, click the '''Import Sub Account''' button. | On the '''Manage Sub Accounts''' page, click the '''Import Sub Account''' button. | ||
| - | |||
| - | + | [[File:Bulk_Import_SubAccount_ManageSubAccount_ImportSubAccount.png|none|500px]] | |
| - | : | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | |} | |
| - | + | ||
| - | + | ||
| + | == Step 3 — Import Sub-Accounts from CSV == | ||
| - | : | + | {| cellspacing="0" style="width: 100%; background: white; border: 1px solid #e2e8f0; border-radius: 12px; padding: 25px; margin: 20px 0; box-shadow: 0 2px 10px rgba(0,0,0,0.06);" |
| - | :: | + | |- |
| - | ::: | + | | style="vertical-align: top;" | |
| - | + | You will now see the '''Import Sub Accounts from CSV''' dialog. | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | '''CSV requirements:''' | |
| - | + | * A '''header''' row is '''required''' in your CSV file. | |
| - | + | * The CSV '''must match''' the format shown in the sample templates. | |
| - | + | * Optional fields can be included as needed. | |
| + | The popup provides two downloadable starter templates: | ||
| + | * '''Download basic sample CSV template''' | ||
| + | * '''Download full sample CSV template''' | ||
| - | + | '''Selecting your file:''' | |
| - | + | * Use '''Choose File''' to select and upload your CSV. | |
| - | + | ||
| - | + | [[File:Bulk_Import_SubAccount_ManageSubAccount_ImportSubAccount_PopUp.png|none|500px]] | |
| - | + | '''Overwrite Mode:''' | |
| - | + | You may optionally check '''Overwrite Existing Sub Accounts Entries'''. | |
| - | + | * If '''enabled''': existing sub-accounts that appear in your CSV will be replaced. | |
| - | : | + | * If '''disabled''': only new sub-accounts will be created. |
| - | + | ||
| - | + | |} | |
| - | + | ||
| - | + | ||
| - | = Step | + | == Step 4 — CSV Template Format Guide == |
| - | + | ||
| - | + | ||
| - | : | + | {| cellspacing="0" style="width: 100%; background: white; border: 1px solid #e2e8f0; border-radius: 12px; padding: 25px; margin: 20px 0; box-shadow: 0 2px 10px rgba(0,0,0,0.06);" |
| + | |- | ||
| + | | style="vertical-align: top;" | | ||
| - | + | Click '''CSV template format guide''' (located under the header note). This opens a page where you can generate a fully formatted CSV file based on selectable options. | |
| - | + | ||
| - | + | ||
| - | : | + | [[File:004_Bulk_Import_SubAccount_ManageSubAccount_ImportSubAccount_CSVGeneratorBasic.png|600px]] |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | |} | |
| - | + | ||
| - | + | = Importing Voicemail = | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | The '''Import Voicemail''' tool allows you to upload multiple voicemail boxes at once using a CSV file. This is useful for onboarding new users, migrating existing voicemail data, or performing large-scale provisioning. | |
| - | + | == Step 1 — Navigate to the Import Voicemail Page == | |
| - | # | + | {| cellspacing="0" style="width: 100%; background: white; border: 1px solid #e2e8f0; border-radius: 12px; padding: 25px; margin: 20px 0; box-shadow: 0 2px 10px rgba(0,0,0,0.06);" |
| - | :: | + | |- |
| - | :: | + | | style="vertical-align: top;" | |
| - | # ''' | + | From your VoIP.ms portal: |
| - | + | # Go to '''DID Numbers''' in the menu | |
| - | + | # Click '''Voicemail''' | |
| - | + | [[File:001_Bulk_Import_Voicemail_ImportVoicemail.png|none|500px]] | |
| - | + | ||
| - | + | |} | |
| - | + | ||
| - | + | == Step 2 — Open the Import Voicemail Tool == | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | {| cellspacing="0" style="width: 100%; background: white; border: 1px solid #e2e8f0; border-radius: 12px; padding: 25px; margin: 20px 0; box-shadow: 0 2px 10px rgba(0,0,0,0.06);" | |
| - | :: | + | |- |
| - | :: | + | | style="vertical-align: top;" | |
| - | + | On the '''Voicemail''' page, click the '''Import Voicemail''' button. | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | [[File:002_Bulk_Import_Voicemail_ImportVoicemail.png|none|500px]] | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | |} | |
| - | + | == Step 3 — Import Voicemail from CSV == | |
| - | + | ||
| - | ; | + | {| cellspacing="0" style="width: 100%; background: white; border: 1px solid #e2e8f0; border-radius: 12px; padding: 25px; margin: 20px 0; box-shadow: 0 2px 10px rgba(0,0,0,0.06);" |
| - | : | + | |- |
| + | | style="vertical-align: top;" | | ||
| - | + | You will now see the '''Import Voicemail from CSV''' dialog. | |
| - | + | ||
| - | + | [[File:003_Bulk_Import_Voicemail_ImportVoicemail_ImportCSV.png|none|500px]] | |
| - | : | + | |
| - | + | Use '''File''' to select and upload your CSV. | |
| - | + | ||
| - | + | ||
| - | + | '''Overwrite Mode:''' | |
| - | : | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | You may optionally check '''Overwrite Existing Voicemail Entries'''. | |
| - | : | + | * If '''enabled''': existing voicemail boxes that appear in your CSV will be replaced. |
| + | * If '''disabled''': only new voicemail boxes will be created. | ||
| - | + | |} | |
| - | + | ||
| - | + | == CSV Requirements == | |
| - | + | ||
| - | ; | + | {| cellspacing="0" style="width: 100%; background: white; border: 1px solid #e2e8f0; border-radius: 12px; padding: 25px; margin: 20px 0; box-shadow: 0 2px 10px rgba(0,0,0,0.06);" |
| - | : | + | |- |
| + | | style="vertical-align: top;" | | ||
| - | + | To successfully import voicemail entries, your CSV file must follow these rules: | |
| - | + | * The file must be in '''CSV (Comma-Separated Value)''' format. | |
| + | * Up to '''18 columns''' are supported. | ||
| + | * Only '''one voicemail entry per row''' is allowed. | ||
| + | * '''Mailbox Number''' and '''Name''' must be unique — duplicates are not permitted. | ||
| - | -- | + | === Required Fields (Columns 1–8) === |
| + | |||
| + | The first eight fields are mandatory for every voicemail entry: | ||
| + | |||
| + | # '''Mailbox Number''' — 1–10 digits. Must be unique. | ||
| + | # '''Name''' — Alphanumeric characters. Must be unique. | ||
| + | # '''Password''' — Exactly 4 digits. | ||
| + | # '''Email''' — Must be a valid email address. | ||
| + | # '''Language''' — <code>en</code> (English), <code>es</code> (Spanish), or <code>fr</code> (French). Default: <code>en</code> | ||
| + | # '''Skip Password''' — <code>yes</code> or <code>no</code>. Default: <code>yes</code> | ||
| + | # '''Transcription Languages''' — Can contain multiple languages using quotes, e.g. <code>"en-US,es-ES"</code>. Default: empty (transcription disabled). | ||
| + | # '''Reseller Client''' — Valid reseller client ID. Default: <code>0</code> | ||
| + | |||
| + | === Optional Advanced Fields (Columns 9–18) === | ||
| + | |||
| + | These fields may be omitted or left empty. If omitted, the system uses the default value. | ||
| + | |||
| + | # '''Say Caller ID''' — <code>yes</code> or <code>no</code>. Default: <code>yes</code> | ||
| + | # '''Say Instructions''' — <code>yes</code> (with instructions) or <code>no</code> (skip). Default: <code>yes</code> | ||
| + | # '''Say Time/Date''' — <code>yes</code> or <code>no</code>. Default: <code>yes</code> | ||
| + | # '''Time Zone''' — e.g. <code>America/New_York</code>, <code>America/Chicago</code>. Default: <code>America/New_York</code> | ||
| + | # '''Unavailable Recording''' — <code>system</code> (default), <code>custom</code> (set by phone), or a Recording ID. | ||
| + | # '''Transcription Delay''' — Number of seconds. Default: <code>0</code> | ||
| + | # '''Transcription Redaction''' — <code>Y</code> or <code>N</code>. Default: <code>N</code> | ||
| + | # '''Transcription Summary''' — <code>Y</code> or <code>N</code>. Default: <code>N</code> | ||
| + | # '''Transcription Sentiment''' — <code>Y</code> or <code>N</code>. Default: <code>N</code> | ||
| + | # '''Transcription Format''' — <code>text</code> or <code>html</code>. Default: <code>text</code> | ||
| + | |||
| + | |} | ||
== Important Notes == | == Important Notes == | ||
| + | |||
| + | {| cellspacing="0" style="width: 100%; background: white; border: 1px solid #e2e8f0; border-radius: 12px; padding: 25px; margin: 20px 0; box-shadow: 0 2px 10px rgba(0,0,0,0.06);" | ||
| + | |- | ||
| + | | style="vertical-align: top;" | | ||
* All 8 required fields must be included for every entry. | * All 8 required fields must be included for every entry. | ||
* Optional fields (columns 9–18) may be left empty. | * Optional fields (columns 9–18) may be left empty. | ||
| - | * Values are case-insensitive (e.g. | + | * Values are case-insensitive (e.g. <code>YES</code>, <code>Yes</code>, and <code>yes</code> are all acceptable). |
| - | * If | + | * If '''Overwrite Existing Voicemail Entries''' is enabled: |
** Matching existing mailboxes will be updated. | ** Matching existing mailboxes will be updated. | ||
** Only provided fields will be changed. | ** Only provided fields will be changed. | ||
** Omitted optional fields will retain their previous values. | ** Omitted optional fields will retain their previous values. | ||
| - | + | |} | |
== CSV Examples == | == CSV Examples == | ||
| + | |||
| + | {| cellspacing="0" style="width: 100%; background: white; border: 1px solid #e2e8f0; border-radius: 12px; padding: 25px; margin: 20px 0; box-shadow: 0 2px 10px rgba(0,0,0,0.06);" | ||
| + | |- | ||
| + | | style="vertical-align: top;" | | ||
=== Example with Required Fields Only === | === Example with Required Fields Only === | ||
| Line 194: | Line 211: | ||
12345,John Doe,1234,[email protected],en,yes,"en-US,es-ES",0,yes,yes,yes,America/New_York,system,0,N,N,N,text | 12345,John Doe,1234,[email protected],en,yes,"en-US,es-ES",0,yes,yes,yes,America/New_York,system,0,N,N,N,text | ||
</pre> | </pre> | ||
| - | + | ||
| + | |} | ||
| + | |||
| + | [[Category:Guides]] | ||
Latest revision as of 18:32, 13 March 2026
|
Bulk Import
Import multiple sub-accounts or voicemail boxes at once using CSV files. |
Contents |
Importing Sub-Accounts
|
From your VoIP.ms portal:
|
Step 2 — Open the Import Sub-Account Tool
|
On the Manage Sub Accounts page, click the Import Sub Account button. |
Step 3 — Import Sub-Accounts from CSV
|
You will now see the Import Sub Accounts from CSV dialog. CSV requirements:
The popup provides two downloadable starter templates:
Selecting your file:
Overwrite Mode: You may optionally check Overwrite Existing Sub Accounts Entries.
|
Step 4 — CSV Template Format Guide
|
Click CSV template format guide (located under the header note). This opens a page where you can generate a fully formatted CSV file based on selectable options. |
Importing Voicemail
The Import Voicemail tool allows you to upload multiple voicemail boxes at once using a CSV file. This is useful for onboarding new users, migrating existing voicemail data, or performing large-scale provisioning.
|
From your VoIP.ms portal:
|
Step 2 — Open the Import Voicemail Tool
|
On the Voicemail page, click the Import Voicemail button. |
Step 3 — Import Voicemail from CSV
|
You will now see the Import Voicemail from CSV dialog. Use File to select and upload your CSV. Overwrite Mode: You may optionally check Overwrite Existing Voicemail Entries.
|
CSV Requirements
|
To successfully import voicemail entries, your CSV file must follow these rules:
Required Fields (Columns 1–8)The first eight fields are mandatory for every voicemail entry:
Optional Advanced Fields (Columns 9–18)These fields may be omitted or left empty. If omitted, the system uses the default value.
|
Important Notes
|
CSV Examples
Example with Required Fields Only12345,John Doe,1234,[email protected],en,yes,,0 Example with Transcription Languages12345,John Doe,1234,[email protected],en,yes,"en-US,es-ES",0 Full Example with All 18 Columns12345,John Doe,1234,[email protected],en,yes,"en-US,es-ES",0,yes,yes,yes,America/New_York,system,0,N,N,N,text |