Restomm Enterprise Accounts

Table of Contents

  • Overview
  • Creating a Sub-account Using the Restcomm Console
  • Checking Sub-account Details
  • Closing Sub-account
  • Account Status Transitions
  • Audit Logs
    • Rationale
    • Events monitored
    • How to request the audit file for your Account?
    • Audit log file format
    • Examples

Overview

Service providers can use sub-accounts to segment phone numbers, collect granular usage data and control data access for their enterprise customers.

Service providers can create sub-accounts using the Restcomm Console or programmatically via the REST API. Phone number related usage statistics for an account can be obtained via the REST API using the credentials of the respective account.

Account and sub-account hierarchy

Creating a Sub-account Using the Restcomm Console

To create a sub-account:

  • Log into the Restcomm Console, using your organization credentials (email and password)
  • Navigate to your account name on the top right of your screen and select Account.

  • Select Sub Accounts on the left hand side.
  • Click on New Account button on the top right of your screen. You should see a screen similar to the one below.

  • Fill out the form above with the sub-account details. Make sure that the password you set is at least at minimum strength. If your password is strong enough, the strength indicator should light up as shown in the screen below. You can follow these guidelines while generating your password to make sure it fits our requirements: use minimum eight characters, include at least one uppercase letter, include lowercase letters, include numbers and special characters. An example of a strong password will be MyC0mp@ny.

  • Select the user role.
    • The role of the account can be Administrator, Developer or ProvisioningAgent. Administrator has full access rights on all platform resources. Developer is like Administrator but is not allowed to manage sub-accounts. ProvisioningAgent is like Developer but is not allowed to read the actual text of SMS messages and cannot remove Recordings.
  • Leave the account status field to Uninitialized.
    • The status of an account can be uninitialized, active, suspended, or closed. Uninitialized status means that an account has been created but not activated by the user. When the user logs into his account for first time, he will be prompted to change his initial password. That is the moment when the account status is changed to activated. The active status shows that the account was activated. The user can start using the Restcomm Console’s functionalities. Accounts with suspended status can’t log into the Console anymore. The account can be reactivated by changing its status to active. Closed account status shows that the account is terminated and all its resource are deleted. Closed accounts can’t be reactivated.
  • Click on the Register button

Checking Sub-account Details

You can see a list of all sub-accounts you registered and check their details using the Restcomm Console interface.

  • Navigate to your account name on the top right of your screen.
  • Select Account from the drop-down list.
  • Click on Sub-accounts on the left hand side.

You will see a list a list of all sub-accounts you have registered, along with their Account SID, Role and Status, similar to the one below:

Closing Sub-account

You can close a sub-account and permanently disable it. When this happens access to the platform through it is revoked and most of its resources are deleted. The actual account entity will remain present though

  • Navigate to your account name on the top right of your screen and select Account
  • Select Sub Accounts on the left hand side.
  • Click on the account name that you want to close.
  • Click on the Close Account button.

  • You will see the following warning screen.

Note that once you close the account, all related resources will be deleted and you will not be able to reopen it.

Account Status Transitions

You can change the account status by navigating to your profile name on the top right of your screen → Account → Sub-accounts and then clicking on account which you want to modify. You will seen a screen similar to the one below.

  • Click on Role drop down field. You will see a list of all possible account statuses. Choose the one you prefer to switch to.
  • Click on the Save Changes button.

Audit Logs

Rationale

The Audit log files will allow the Restcomm cloud customers to monitor their Organizations/Accounts and track all administrative operations.

For example, it will allow tracking the following operations:

  • When a number is provisioned
  • When a change in the account security settings happens
  • When a recording file is deleted
  • When a new SIP Client is created
  • When an application is assigned to a number

These events are generated every time an action is taken within Restcomm, regardless of whether that action was taken through the API or by a user in the Restcomm Console.

Events monitored

Restcomm will monitor all Create, Update and Delete actions performed on the following resources:

  • Accounts
  • Applications
  • Phone Numbers
  • Recordings (Delete only)
  • Restcomm Clients
  • XMPP Domain
  • XMPP Whitelist
  • XMPP Mappings
  • BYON: Voice & SMS Requests

How to request the audit file for your Account?

In this initial phase we won’t expose this audit logs via the Console or API, so you will need to contact Telestax via the normal channels to request it.

We recommend you to request the Audit file by opening a Support ticket using your Zendesk account.

The information you need to share is the following:

  • The Account SID (or the multiple Account/Sub-Account SIDs) for which you need the Audit logs
  • The period of time you need to see covered
    • We recommend asking this in a monthly period
    • The current retention policy is to keep this Audit log file for 3 months INFORMATION: if you need to have it saved for longer, please request them on a monthly basis and backup them on your system

Upon your request, our support team will collect the Audit logs and share them with on the generated ticket.

Audit log file format

The audit file provided has a CSV format with the following information:

  • Restcomm Console/API
    • Date
      • Date and Time (in milliseconds) of the operation in UTC *8 AccountSid
      • The Restcomm identifier of the Account where the event happened
    • AccountEmail
      • The login email that made the operation
    • OrganizationSid
      • The Restcomm identifier of the Organization where the event happened
    • OrganizationDomain
      • The domain of the Organization where the event happened
    • Role
      • User Role/Privilege
    • IP Address
      • Source IP originator of the change
    • Resource
      • Which Resource was affected
      • Accounts, Applications, IncomingPhoneNumbers, Clients or Recordings
    • Action
      • What type of event was done – create, update, delete
    • Sid
      • Internal identifier of the resource affected
      • Present for the update and delete operations
    • Parameters
      • What change was made
      • Contains the values after the change
  • Restcomm Message Exchange API
    • Date
      • Date and Time (in milliseconds) of the operation in UTC
    • AccountEmail
      • The login email that made the operation
    • AccountSid
      • The Restcomm identifier of the Account where the event happened
    • IP Address
      • Source IP originator of the change
    • Resource
      • Which Resource was affected
      • Domains, XMPP Mapping or White list rules
    • Action
      • What type of event was done – create, update, delete
    • Id
      • Internal identifier of the resource affected
      • Present for the update and delete operations
    • Parameters
      • What change was made
      • Contains the values after the change

Examples

Check below the following examples and description of each operation.

Restcomm Console/API

  • Creation of a new Account made by user admin@mail.com under the Account “ACae6e420f425248d6a26948c1xxxxxx”. The details of the new Account are “{Status=[ACTIVE], FriendlyName=[newaccount4], Password=[abc123], EmailAddress=[newaccount4@email.com], Role=[Developer]}”
Date,AccountSid,AccountEmail,OrganizationSid,OrganizationDomain,Role,IP Address,Resource,Action,Sid,Parameters
"2018-10-29T17:22:42,435+02",ACae6e420f425248d6a26948c1xxxxxx,admin@mail.com,ORafbe225ad37541eba518a742xxxxxxx,asterix,Administrator,192.168.1.1,Accounts,Create,,"{Status=[ACTIVE], FriendlyName=[newaccount4], Password=[abc123], EmailAddress=[newaccount4@email.com], Role=[Developer]}"
  • Update of the configuration for the Phone number “PNfc3e9c907f9340a1b02894d82xxxxxx” to set the voice application to the application “AP86a8bc22ce374067890780bxxxxxxx”. This operation was made from the IP 192.168.1.1 by the user admin@mail.com.
Date,AccountSid,AccountEmail,OrganizationSid,OrganizationDomain,Role,IP Address,Resource,Action,Sid,Parameters
"2018-10-29T17:28:57,704+02",ACae6e420f425248d6a26948c1xxxxxx,admin@mail.com,ORafbe225ad37541eba518a742xxxxxxx,asterix,Administrator,192.168.1.1,IncomingPhoneNumbers,Update,PNfc3e9c907f9340a1b02894d82xxxxxx,"{VoiceFallbackUrl=[], UssdFallbackMethod=[POST], FriendlyName=[412341], UssdApplicationSid=[], PhoneNumber=[412341], VoiceApplicationSid=[AP86a8bc22ce374067890780bxxxxxxx], UssdFallbackUrl=[], VoiceUrl=[], SmsUrl=[], ReferUrl=[], UssdMethod=[POST], VoiceMethod=[POST], VoiceFallbackMethod=[POST], ReferMethod=[POST], StatusCallback=[], SmsApplicationSid=[], SmsFallbackMethod=[POST], StatusCallbackMethod=[POST], ReferApplicationSid=[], SmsFallbackUrl=[], UssdUrl=[], SmsMethod=[POST]}"
  • Delete of the recording “RE50675909d9c94acda36f0e119xxxxxx”
Date,AccountSid,AccountEmail,OrganizationSid,OrganizationDomain,Role,IP Address,Resource,Action,Sid,Parameters
"2018-10-29T17:30:33,106+02",ACae6e420f425248d6a26948c1xxxxxx,admin@mail.com,ORafbe225ad37541eba518a742xxxxxxx,asterix,Administrator,192.168.1.1,Recordings,Delete,RE50675909d9c94acda36f0e119xxxxxx,{}

Restcomm Message Exchange API

  • Update of the XMPP Mapping made by user@email.com on the mapping “XM5c8651c6d262437188c16fa0xxxxxx” to the following “{ “”jabberAddress””: “”joe@uc3.mycompany.com””, “”domain””: “”mydomain.com””, “”externalAddress””: 19111111111}”
Date,AccountEmail,AccountSid,IP Address,Resource,Action,Id,Parameters
2018-11-05T17:30:43.177+02,user@email.com,ACd239d5cab74caaa43a594772xxxxxx,0:0:0:0:0:0:0:1,xmppMappings,Update,XM5c8651c6d262437188c16fa0xxxxxx,"{ ""jabberAddress"": ""joe@uc3.mycompany.com"", ""domain"": ""mydomain.com"", ""externalAddress"": 19111111111}"
  • Creation of a new Whitelist IP entry for the Account “ACd239d5cab74caaa43a594772xxxxxx” made by user@email.com.
Date,AccountEmail,AccountSid,IP Address,Resource,Action,Id,Parameters
2018-11-05T17:33:25.689+02,user@email.com,ACd239d5cab74caaa43a594772xxxxxx,0:0:0:0:0:0:0:1,whitelistRules,Create,,"{ ""ipAddress"": ""10.10.10.10"" }"

Get awesome content in your inbox every week.

Give it a try. It only takes a click to unsubscribe.