This API checks a CSV UTF-8 content for mass-provisioning for directory mode.

All the entries defined in the CSV data are relative to the same company directory .

In case a query parameter commandId is added, the following XMPP message is sent to the initiator of the command:

<message id="8413b42e-563c-4437-9a53-06f638b5ab69_0" type="management"
    from="pcloud_enduser_1@openrainbow.com/172440802160413612281463752830017532"
    to="5abb735b2d3c4e50adde276c50ec489c@@openrainbow.com"
    xmlns="jabber:client">
    <command_ended  commandId="xyz" xmlns="jabber:iq:configuration"/>
</message>

The first line of the CSV file describes the content format. Most of the field names are the same than the field names of the company directory API - Create a directory entry.

Supported fields are:

• __action__    delete, upsert or sync
• ldap_id    (mandatory)
*
• firstName
• lastName
• companyName
• workPhoneNumber{n}    (n is a number starting from 0 or 9)
• mobilePhoneNumber{n}    (n is a number starting from 0 or 9)
• otherPhoneNumber{n}    (n is a number starting from 0 or 9)
• aliasType{n}    (n is a digit from 0 to 9)
• aliasCode{n}    (n is a digit from 0 to 9)
• tag{n}    (n is a number starting from 0 to 4)
• department
• street
• city
• postalCode
• state
• country
• jobTitle
• eMail
• custom1
• custom2

delete: allows to delete an entry. upsert: allows to modify an entry (update or create if doesn't exists) with filled fields. Remark: empty fields are not taken into account. sync: allows to modify an entry (update or create if doesn't exists) with filled fields. Remark: empty fields are taken into account (if a field is empty we will try to update it with empty value).

This API allows to delete the last not pending import report of a company directory.

superadmin can delete the last report of the import of the directory of any company.
bp_admin can only delete the last report of the import of the directory of their own companies or their End Customer companies.
organization_admin can only delete the last report of the import of the directory of the companies under their organization.
company_admin and directory_admin can only delete the last report of the import of the directory of their onw companies.

This API provides a short status of the last import (completed or pending) of a company directory.

superadmin can get the status of the import of the directory of any company.
bp_admin can only get the status of the import of the directory of their own companies or their End Customer companies.
organization_admin can only get the status of the import of the directory of the companies under their organization.
company_admin and directory_admin can only get the status of the import of the directory of their onw companies.

This API allows to delete the last not pending import report of a personal directory.

This API provides a short status of the last import (completed or pending) of a personal directory.

This API retrieves the last checks CSV UTF-8 content for mass-provisioning for directory mode, performed by an admin (using a commandId).

This API provides the detailed report of the last import (completed or pending) of a company directory.

superadmin can get the detailed report of the import of the directory of any company.
bp_admin can only get the detailed report of the import of the directory of their own companies or their End Customer companies.
organization_admin can only get the detailed report of the import of the directory of the companies under their organization.
company_admin and directory_admin can only get the detailed report of the import of the directory of their onw companies.

This API provides the detailed report of the last import (completed or pending) of a personal directory.

This API retrieves the last import CSV UTF-8 content for mass-provisioning for directory mode, performed by an admin (using a commandId).

This API allows to create a report for a commandId in case no other API is called (no action to be performed, error, ...).

This API provides a CSV template.

This API allows to check the entries of a company or user's personal directory with CSV UTF-8 encoded data.

All the entries defined in the CSV data are relative to the same company directory (the companyId, if it is given as parameter) or to the personal directory of the logged user.

The first line of the CSV file describes the content format. Most of the field names are the same as the field names of the company directory API - Create a directory entry.

Supported fields are:

• firstName
• lastName
• companyName
• department
• street
• city
• postalCode
• state
• country
• workPhoneNumber{n} (where {n} is a digit from 0 to 9)
• mobilePhoneNumber{n} (where {n} is a digit from 0 to 9)
• otherPhoneNumber{n} (where {n} is a digit from 0 to 9)
• aliasType{n} (where {n} is a digit from 0 to 9)
• aliasCode{n} (where {n} is a digit from 0 to 9)
• jobTitle
• eMail
• tag{n} (where {n} is a digit from 0 to 4)
• custom1
• custom2

superadmin can import directory entries for any company.
bp_admin can only import directory entries for their own companies or their End Customer companies.
organization_admin can only import directory entries for the companies under their organization.
company_admin and directory_admin can only import directory entries for their onw companies.
user can only import directory entries for their personal directory.

This API allows to import the entries of a company directory or user's personal directory with CSV UTF-8 encoded data.

All the entries defined in the CSV data are relative to the same company directory (the companyId, if it is given as parameter) or to the personal directory of the logged user.

NOTE If the directory is not empty, it is deleted before the import.

The first line of the CSV file describes the content format. Most of the field names are the same as the field names of the directory API - Create a directory entry.

Supported fields are:

• firstName
• lastName
• companyName
• department
• street
• city
• postalCode
• state
• country
• workPhoneNumber{n} (where {n} is a digit from 0 to 9)
• mobilePhoneNumber{n} (where {n} is a digit from 0 to 9)
• otherPhoneNumber{n} (where {n} is a digit from 0 to 9)
• jobTitle
• eMail
• tag{n} (where {n} is a digit from 0 to 4)
• custom1
• custom2

superadmin can import directory entries for any company.
bp_admin can only import directory entries for their own companies or their End Customer companies.
organization_admin can only import directory entries for the companies under their organization.
company_admin and directory_admin can only import directory entries for their onw companies.
user can only import directory entries for their personal directory.

This API allows to import the entries of a company directory with CSV UTF-8 encoded data.

All the entries defined in the CSV data are relative to the same company directory.

The first line of the CSV file describes the content format. Most of the field names are the same than the field names of the company directory API - Create a directory entry.

Supported fields are:

• __action__    delete, upsert or sync
• ldap_id    (mandatory)
*
• firstName
• lastName
• companyName
• workPhoneNumber{n}    (n is a number starting from 0 or 9)
• mobilePhoneNumber{n}    (n is a number starting from 0 or 9)
• otherPhoneNumber{n}    (n is a number starting from 0 or 9)
• tag{n}    (n is a number starting from 0 to 4)
• department
• street
• city
• postalCode
• state
• country
• jobTitle
• eMail
• custom1
• custom2

delete: allows to delete an entry. upsert: allows to modify an entry (update or create if doesn't exists) with filled fields. Remark: empty fields are not taken into account. sync: allows to modify an entry (update or create if doesn't exists) with filled fields. Remark1: empty fields are taken into account (if a field is empty we will try to update it with empty value). Remark2: existing entries not in the CSV file will be automatically deleted.

In case a query parameter commandId is added, the following XMPP message is sent to the initiator of the command:

<message id="8413b42e-563c-4437-9a53-06f638b5ab69_0" type="management"
    from="pcloud_enduser_1@openrainbow.com/172440802160413612281463752830017532"
    to="5abb735b2d3c4e50adde276c50ec489c@@openrainbow.com"
    xmlns="jabber:client">
    <command_ended  commandId="xyz" xmlns="jabber:iq:configuration"/>
</message>

This API generates a file describing all companies entries (csv or json format).

This API checks a CSV UTF-8 content for mass-provisioning. Caution: To use the comment character ('%' by default) in a field value, surround this value with double quotes.

This API checks a CSV UTF-8 content for mass-provisioning for useranddevice mode. Caution: To use the comment character ('%' by default) in a field value, surround this value with double quotes.

• In case a query parameter commandId is added, the following XMPP message is sent to the initiator of the command:

  <message id="8413b42e-563c-4437-9a53-06f638b5ab69_0" type="management"
    from="pcloud_enduser_1@openrainbow.com/172440802160413612281463752830017532"
    to="5abb735b2d3c4e50adde276c50ec489c@@openrainbow.com"
    xmlns="jabber:client">
    <command_ended  commandId="xyz" xmlns="jabber:iq:configuration"/>
  </message>

This API allows to delete the report of an import identified by its reqId.

This API allows to access the report of an import identified by its reqId.

This API exports the list of users as CSV UTF-8 data.
The first line of the CSV data describes the content format (column names).

Most of the field names are the field names of the admin createUser API.

This API exports the list of deleted users as CSV UTF-8 data.

This API retrieves the last import CSV UTF-8 content for mass-provisioning for useranddevice mode, performed by an admin.
The first line of the CSV data describes the content format. Most of the field names are the field names of the admin createUser API.

This API retrieves the last checks CSV UTF-8 content for mass-provisioning for useranddevice mode, performed by an admin (using a commandId).

This API provides information on all imports of the administrator's company.

This API allows to manage Rainbow users or devices through a CSV UTF-8 encoded file.
The first line of the CSV data describes the content format. Most of the field names are the field names of the admin createUser API.

Caution: To avoid multiple imports of same CSV data, the reqId returned to access the import status is a hash of the CSV data. If you really need to apply same CSV data again, you will have to delete its associated import report first.

Supported fields for "user" management are:

• __action__    delete, update or create (by default)
• loginEmail    (mandatory)
• password    (mandatory)
• title
• firstName
• lastName
• nickName
• businessPhone{n}    (n is a number starting from 0 or 1)
• mobilePhone{n}    (n is a number starting from 0 or 1)
• email{n}    (n is a number starting from 0 or 1)
• tags{n}    (n is a number starting from 0 to 4)
• jobTitle
• department
• userInfo1
• userInfo2
• country
• language
• timezone
• visibility
• isInitialized
• isActive
• authenticationType
• selectedAppCustomisationTemplateName
• selectedManifestName
• service{n}
• photoUrl

Supported fields for "device" management are:

• __action__    detach, attach or force_attach
• loginEmail    (mandatory)
• pbxId
• pbxShortNumber
• pbxInternalNumber
• number

Caution: To use the comment character ('%' by default) in a field value, surround this value with double quotes.

Error codes

• 1001 'phoneNumber {pbxId}/{shortNumber} has no system id'
• 1002 'phoneNumber {pbxId}/{shortNumber} has no id'
• 1003 'phoneNumber {pbxId}/{shortNumber} does not exist'
• 1004 'cannot lookup phoneNumber {pbxId}/{shortNumber}'
• 1005 'found {count} phoneNumber(s) for {companyId}/{shortNumber}'
• 1006 'failed to find one single PBX for {companyId}/{shortNumber}'
• 1007 'user has already a phoneNumber {pbxId}/{shortNumber}'
• 1008 'phoneNumber {pbxId}/{shortNumber} already associated to user {userId}'
• 1009 'failed to attach phoneNumber {pbxId}/{shortNumber}'
• 1010 'user {userId} has no phoneNumber'
• 1011 'user {userId} has too many phoneNumbers'
• 1012 'failed to detach phoneNumber {pbxId}/{shortNumber}'

This API retrieves the last import CSV UTF-8 content for mass-provisioning for useranddevice mode, performed by an admin (using a commandId).

This API allows to create a report for a commandId in case no other API is called (no action to be performed, error, ...).

This API allows to synchronize Rainbow users or devices through a CSV UTF-8 encoded file. it is a merge from user mode and device mode
The first line of the CSV data describes the content format. Most of the field names are the field names of the admin createUser API.

Supported fields for "user" management are:

• __action__    delete, upsert, sync or detach
• loginEmail    (mandatory)
• password    (mandatory)
• title
• firstName
• lastName
• nickName
• businessPhone{n}    (n is a number starting from 0 or 1)
• mobilePhone{n}    (n is a number starting from 0 or 1)
• email{n}    (n is a number starting from 0 or 1)
• tags{n}    (n is a number starting from 0 to 4)
• jobTitle
• department
• userInfo1
• userInfo2
• country
• language
• timezone
• visibility
• isInitialized
• isActive
• authenticationType
• service{n}
• photoUrl

Supported fields for "device" management are:

• loginEmail    (mandatory)
• pbxId
• pbxLdapId
• pbxShortNumber
• pbxInternalNumber
• number

detach: allows to detach an PBX extension from a user. delete: allows to delete a user. upsert: allows to modify user (update or create if doesn't exists) and device (force attach if filled) with filled fields. Remark: empty fields are not taken into account. sync: allows to modify user (update or create if doesn't exists) and device (force attach if filled, detach if empty) with filled fields. Remark: empty fields are taken into account (if a field is empty we will try to update it with empty value).

Caution: To use the comment character ('%' by default) in a field value, surround this value with double quotes. Caution: for sync action:

• As empty fields are taken into account, all fields must be filled to avoid a reset of these values
• As empty fields are taken into account, it is better to avoid mixing sync __action__ with others actions

Error codes

• 1001 'phoneNumber {pbxId}/{shortNumber} has no system id'
• 1002 'phoneNumber {pbxId}/{shortNumber} has no id'
• 1003 'phoneNumber {pbxId}/{shortNumber} does not exist'
• 1004 'cannot lookup phoneNumber {pbxId}/{shortNumber}'
• 1005 'found {count} phoneNumber(s) for {companyId}/{shortNumber}'
• 1006 'failed to find one single PBX for {companyId}/{shortNumber}'
• 1007 'user has already a phoneNumber {pbxId}/{shortNumber}'
• 1008 'phoneNumber {pbxId}/{shortNumber} already associated to user {userId}'
• 1009 'failed to attach phoneNumber {pbxId}/{shortNumber}'
• 1010 'user {userId} has no phoneNumber'
• 1011 'user {userId} has too many phoneNumbers'
• 1012 'failed to detach phoneNumber {pbxId}/{shortNumber}'
• 1013 '{pbxLdapId} has no system with a pbxId'