Bulk Import - VoIP.ms Wiki

Check out our YouTube channel to watch our simple tutorials that will help you set up most of our features.

Bulk Import

From VoIP.ms Wiki

(Difference between revisions)
Jump to: navigation, search
[checked revision][checked revision]
(Step 3 — Import Sub Accounts from CSV)
 
(2 intermediate revisions not shown)
Line 1: Line 1:
-
=Importing Sub Accounts=
+
{| 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;" |
-
= Importing Sub‑Accounts Using CSV =
+
<div style="font-size: 2.8em; font-weight: 200; color: #1e293b; margin-bottom: 15px; letter-spacing: -2px;">Bulk Import</div>
-
This guide explains how to import multiple sub‑accounts using the CSV bulk‑upload tools.
+
-
It includes navigation steps, CSV requirements, and how to use the CSV Template Format Guide to generate properly formatted CSV content.
+
-
== Step 1 — Navigate to the Import Sub‑Account Page ==
+
<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:
+
|}
-
:1) Go on menu '''Sub-Account'''  
+
 
-
:2) Click '''Manage Sub Account'''
+
__TOC__
-
:: [[File:Bulk_Import_SubAccount_ManageSubAccount.png|none|500px]]
+
 
 +
= 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;" |
-
== Step 2 — Open the Import Sub‑Account Tool ==
 
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 ==
+
[[File:Bulk_Import_SubAccount_ManageSubAccount_ImportSubAccount.png|none|500px]]
-
: You will now see the '''Import Sub Accounts''' from CSV dialog:
+
-
:* A '''header''' row is '''required''' in your CSV file.
+
-
:* The CSV '''must match''' the format shown in the sample templates.
+
-
:: To help with formatting, the popup provides:
+
-
::* '''Download basic sample CSV template'''
+
-
::* '''Download full sample CSV template'''
+
-
:* Optional fields can be included as needed.
+
-
: '''Select CSV file'''
+
|}
-
::* Use '''Choose File''' to select and upload your CSV.
+
-
: [[File:Bulk_Import_SubAccount_ManageSubAccount_ImportSubAccount_PopUp.png|none|500px]]
+
 +
== Step 3 — Import Sub-Accounts from CSV ==
-
: '''Overwrite Mode'''
+
{| 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);"
-
:: You may optionally check:
+
|-
-
:::* Overwrite Existing Sub Accounts Entries
+
| style="vertical-align: top;" |
-
:: If this option is enabled:
+
You will now see the '''Import Sub Accounts from CSV''' dialog.
-
:::* Existing sub‑accounts that appear in your CSV will be replaced.
+
-
:: If disabled:
+
-
:::* Only new sub‑accounts will be created.
+
-
== Step 4 — CSV Template Format Guide ==
+
'''CSV requirements:'''
-
: Click CSV template format guide (located under the header note).
+
* A '''header''' row is '''required''' in your CSV file.
-
: This opens the page where you can generate a fully formatted CSV file based on selectable options.
+
* The CSV '''must match''' the format shown in the sample templates.
-
:: [[File:004_Bulk_Import_SubAccount_ManageSubAccount_ImportSubAccount_CSVGeneratorBasic.png|800px]]
+
* Optional fields can be included as needed.
 +
The popup provides two downloadable starter templates:
 +
* '''Download basic sample CSV template'''
 +
* '''Download full sample CSV template'''
-
= Importing Voicemail Using CSV =
+
'''Selecting your file:'''
-
The '''Import Voicemail''' tool allows you to upload multiple voicemail boxes at once using a CSV file. 
+
* Use '''Choose File''' to select and upload your CSV.
-
This is useful for onboarding new users, migrating existing voicemail data, or performing large-scale provisioning.
+
-
You can access this tool by navigating to:
+
[[File:Bulk_Import_SubAccount_ManageSubAccount_ImportSubAccount_PopUp.png|none|500px]]
-
== Step 1 — Navigate to the Import Voicemail Page ==
+
'''Overwrite Mode:'''
-
: From your VoIP.ms portal:
+
You may optionally check '''Overwrite Existing Sub Accounts Entries'''.
-
: 1) Go on menu '''DID Numbers'''  
+
* If '''enabled''': existing sub-accounts that appear in your CSV will be replaced.
-
: 2) Click '''Voicemail'''
+
* If '''disabled''': only new sub-accounts will be created.
-
:: [[File:001_Bulk_Import_Voicemail_ImportVoicemail.png|none|500px]]
+
-
== Step 2 — Open the Import Sub‑Account Tool ==
+
|}
-
On the '''Manage Sub Accounts''' page, click the '''Import Sub Account''' button.
+
-
:: [[File:002_Bulk_Import_Voicemail_ImportVoicemail.png|none|500px]]
+
-
= Step 3 - Importing Voicemails Using CSV =
+
== Step 4 — CSV Template Format Guide ==
-
: 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.
+
{| 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;" |
-
== Overwrite Mode ==
+
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.
-
: You may optionally check:
+
-
::* Overwrite Existing Sub Accounts Entries
+
-
: If this option is enabled:
+
[[File:004_Bulk_Import_SubAccount_ManageSubAccount_ImportSubAccount_CSVGeneratorBasic.png|600px]]
-
::* Existing sub‑accounts that appear in your CSV will be replaced.
+
-
: If disabled:
+
-
::* Only new sub‑accounts will be created.
+
-
'''CSV Requirements'''
+
|}
-
: To successfully import voicemail entries, your CSV file must follow these rules:
+
-
:* The file must be in '''CSV (Comma-Separated Value)''' format.
+
= Importing Voicemail =
-
:* 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 '''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.
-
The first eight fields are mandatory for every voicemail entry:
+
== Step 1 — Navigate to the Import Voicemail Page ==
-
# '''Mailbox Number:''' 
+
{| 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);"
-
::* 1–10 digits 
+
|-
-
::* Must be unique
+
| style="vertical-align: top;" |
-
# '''Name:'''
+
From your VoIP.ms portal:
-
::* Alphanumeric characters 
+
# Go to '''DID Numbers''' in the menu
-
::* Must be unique
+
# Click '''Voicemail'''
-
# '''Password:''' 
+
[[File:001_Bulk_Import_Voicemail_ImportVoicemail.png|none|500px]]
-
::* Exactly 4 digits
+
-
# '''Email:''' 
+
|}
-
::* Must be a valid email address
+
-
# '''Language:''' 
+
== Step 2 Open the Import Voicemail Tool ==
-
::* Acceptable values: 
+
-
:::* <code>en</code> English 
+
-
:::* <code>es</code> — Spanish 
+
-
:::* <code>fr</code> — French 
+
-
::* Default: <code>en</code>
+
-
# '''Skip Password:''' 
+
{| 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);"
-
::* <code>yes</code> or <code>no</code> 
+
|-
-
::* Default: <code>yes</code>
+
| style="vertical-align: top;" |
-
# '''Transcription Languages:'''
+
On the '''Voicemail''' page, click the '''Import Voicemail''' button.
-
::* Can contain multiple languages using quotes 
+
-
::* Example: <code>"en-US,es-ES"</code> 
+
-
::* Default: empty (transcription disabled)
+
-
# '''Reseller Client:''' 
+
[[File:002_Bulk_Import_Voicemail_ImportVoicemail.png|none|500px]]
-
::* Valid reseller client ID 
+
-
::* Default: <code>0</code>
+
-
----
+
-
== Optional Advanced Fields (Columns 9–18) ==
+
|}
-
These fields may be omitted or left empty. 
+
== Step 3 — Import Voicemail from CSV ==
-
If omitted, the system uses the default value.
+
-
; 9. Say Caller ID
+
{| 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);"
-
: <code>yes</code> or <code>no</code>. Default: <code>yes</code>
+
|-
 +
| style="vertical-align: top;" |
-
; 10. Say Instructions
+
You will now see the '''Import Voicemail from CSV''' dialog.
-
: <code>yes</code> (with instructions) or <code>no</code> (skip). Default: <code>yes</code>
+
-
; 11. Say Time/Date
+
[[File:003_Bulk_Import_Voicemail_ImportVoicemail_ImportCSV.png|none|500px]]
-
: <code>yes</code> or <code>no</code>. Default: <code>yes</code>
+
-
; 12. Time Zone
+
Use '''File''' to select and upload your CSV.
-
: Examples: <code>America/New_York</code>, <code>America/Chicago</code> 
+
-
: Default: <code>America/New_York</code>
+
-
; 13. Unavailable Recording
+
'''Overwrite Mode:'''
-
: Values: 
+
-
::* <code>system</code> (default) 
+
-
::* <code>custom</code> (set by phone) 
+
-
::* Recording ID
+
-
; 14. Transcription Delay
+
You may optionally check '''Overwrite Existing Voicemail Entries'''.
-
: Number of seconds. Default: <code>0</code>
+
* If '''enabled''': existing voicemail boxes that appear in your CSV will be replaced.
 +
* If '''disabled''': only new voicemail boxes will be created.
-
; 15. Transcription Redaction
+
|}
-
: <code>Y</code> or <code>N</code>. Default: <code>N</code>
+
-
; 16. Transcription Summary
+
== CSV Requirements ==
-
: <code>Y</code> or <code>N</code>. Default: <code>N</code>
+
-
; 17. Transcription Sentiment
+
{| 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);"
-
: <code>Y</code> or <code>N</code>. Default: <code>N</code>
+
|-
 +
| style="vertical-align: top;" |
-
; 18. Transcription Format
+
To successfully import voicemail entries, your CSV file must follow these rules:
-
: <code>text</code> or <code>html</code>. Default: <code>text</code>
+
* 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., <code>YES</code>, <code>Yes</code>, <code>yes</code> are all acceptable).
+
* Values are case-insensitive (e.g. <code>YES</code>, <code>Yes</code>, and <code>yes</code> are all acceptable).
-
* If the option '''Overwrite Existing Voicemail Entries''' is enabled:
+
* 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

Step 1 — Navigate to the Import Sub-Account Page

From your VoIP.ms portal:

  1. Go to Sub-Account in the menu
  2. Click Manage Sub Account
Bulk Import SubAccount ManageSubAccount.png

Step 2 — Open the Import Sub-Account Tool

On the Manage Sub Accounts page, click the Import Sub Account button.

Bulk Import SubAccount ManageSubAccount ImportSubAccount.png

Step 3 — Import Sub-Accounts from CSV

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.
Bulk Import SubAccount ManageSubAccount ImportSubAccount PopUp.png

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 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.

004 Bulk Import SubAccount ManageSubAccount ImportSubAccount CSVGeneratorBasic.png

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

From your VoIP.ms portal:

  1. Go to DID Numbers in the menu
  2. Click Voicemail
001 Bulk Import Voicemail ImportVoicemail.png

Step 2 — Open the Import Voicemail Tool

On the Voicemail page, click the Import Voicemail button.

002 Bulk Import Voicemail ImportVoicemail.png

Step 3 — Import Voicemail from CSV

You will now see the Import Voicemail from CSV dialog.

003 Bulk Import Voicemail ImportVoicemail ImportCSV.png

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

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:

  1. Mailbox Number — 1–10 digits. Must be unique.
  2. Name — Alphanumeric characters. Must be unique.
  3. Password — Exactly 4 digits.
  4. Email — Must be a valid email address.
  5. Languageen (English), es (Spanish), or fr (French). Default: en
  6. Skip Passwordyes or no. Default: yes
  7. Transcription Languages — Can contain multiple languages using quotes, e.g. "en-US,es-ES". Default: empty (transcription disabled).
  8. Reseller Client — Valid reseller client ID. Default: 0

Optional Advanced Fields (Columns 9–18)

These fields may be omitted or left empty. If omitted, the system uses the default value.

  1. Say Caller IDyes or no. Default: yes
  2. Say Instructionsyes (with instructions) or no (skip). Default: yes
  3. Say Time/Dateyes or no. Default: yes
  4. Time Zone — e.g. America/New_York, America/Chicago. Default: America/New_York
  5. Unavailable Recordingsystem (default), custom (set by phone), or a Recording ID.
  6. Transcription Delay — Number of seconds. Default: 0
  7. Transcription RedactionY or N. Default: N
  8. Transcription SummaryY or N. Default: N
  9. Transcription SentimentY or N. Default: N
  10. Transcription Formattext or html. Default: text

Important Notes

  • All 8 required fields must be included for every entry.
  • Optional fields (columns 9–18) may be left empty.
  • Values are case-insensitive (e.g. YES, Yes, and yes are all acceptable).
  • If Overwrite Existing Voicemail Entries is enabled:
    • Matching existing mailboxes will be updated.
    • Only provided fields will be changed.
    • Omitted optional fields will retain their previous values.

CSV Examples

Example with Required Fields Only

12345,John Doe,1234,[email protected],en,yes,,0

Example with Transcription Languages

12345,John Doe,1234,[email protected],en,yes,"en-US,es-ES",0

Full Example with All 18 Columns

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
Personal tools
Namespaces
Variants
Actions
VoIP.ms Wiki
Guides 🇨🇦
Guías 🇲🇽