Import users from CSV

Import up to 500 users per batch, in a CSV file no larger than 1 MB. Each row represents one managed user with one SIP account. All rows in a batch use the tenant selected on the portal page.

For saving, retrieving and replacing codes, see Users & QR codes.

Import and generate

1. Open Users & QR codes  from the main menu.
2. Select the tenant for this batch, then select Import CSV.
3. Select Download CSV template and replace its example values with your users’ details.
4. Upload the file under CSV file, or paste its contents into CSV contents.
5. Select Validate and preview. Check the tenant, user references, new/existing counts and any capacity shortfall. Validation does not save the users or issue codes.
6. Correct errors or prepay for additional capacity, then validate again.
7. Select Save and generate batch. The new and updated users are selected in Saved users.
8. Select Download selected as ZIP. Each code is single-use and expires 72 hours after generation.

A rejected batch does not partially update users or replace their existing codes. Existing references update users already assigned to the selected tenant; new references consume available user slots. Duplicate references within the same CSV are rejected.

Example CSV

These are example credentials only. Replace them with the details supplied by your PBX provider and use the required transport.

userRef,displayName,SipUsername,SipPassword,Subdomain,Transport
guide-001,Alex,1001,replace-this-password,pbx.example.com,TLS
guide-002,"Sam, City Tours",1002,"example,password",pbx.example.com,TLS

Do not add a tenant column. Choose the tenant in the portal. To import users for another tenant, select it and import a separate batch.

Columns

The importer also accepts Srtp, MediaKeyExchange, RtcpMux, Messaging, Video and CallRecording. Use values supported by your app and provider; the SIP username, password and other text fields must each be no longer than 512 characters. Do not include unrelated spreadsheet columns.

Column headings are case-insensitive. The parser also ignores spaces, underscores and hyphens in headings, but the template names are recommended. Transport values must use the uppercase spellings shown above.

CSV supports one SIP account per row and does not accept XMPP columns. Use Generate one or the API for a profile containing multiple SIP accounts or XMPP accounts.

Preparing the file

• Save as a comma-separated UTF-8 CSV, not an Excel workbook or semicolon-separated file.
• Format usernames as text before exporting from a spreadsheet so leading zeroes are preserved.
• Put a value containing a comma, quote or line break inside double quotes. Represent a quote inside that value with two quotes: "a""b" imports as a"b.
• Keep the same number of fields on every row. A blank optional field still needs its comma separator.
• Split larger imports into batches of no more than 500 users. Keep the file containing passwords private.

Updating existing users

Reuse the same userRef and select the tenant that user is currently attached to. Importing an existing user replaces their saved account details and creates a new code; it invalidates their previous unused code without consuming another slot.

An import is a complete profile update, not a partial field merge. Supply all SIP options you need to retain. CSV updates contain one SIP account and no XMPP accounts, so use Edit or the API to preserve a multi-account or XMPP profile.

If the user needs a different tenant, use Edit in Saved users first. The destination tenant must be in the same subscription.

Common import errors

Closing the page after a successful import does not lose its users. Return to Saved users to view or download active codes, or generate replacements.