Users

Each user represents one person using the service, an admin or a fax machine

User Parameters

Name

This is the users long name, and will be used for CallerID inside the organization

Extension

This is the extension used to dial or send messages to the user. It must be unique

Username

This is the users username on the platform for identification purposes. It must be unique

SIP Password

This is the password used for authenticating VoIP devices to this users account.

Important

It is STRONGLY recommended you not changes this unless you are absolutely certain you know what you are doing. Changing this will affect your service

Max Bindings

This is the maximum number of concurrent devices the user can have registered. It is set conservatively to 10. It should not be changed unless you are certain.

PIN

This is the users OnCall pin. We generate one randomly.

This is not the users voicemail pin. That is set on the mailbox.

External CallerID Name

Outound callerID name will be what is entered here. This MAY be different from the users name for display purposes.

External CallerID Number

Outbound calls from this user will come from the number selected here. If nothing is selected, they will come from the accounts default callerID

Mobile

The users mobile phone number. Described here

Call Timeout

The call timeout for the users call behaviors. This is described in detail here

Forward Behavior

How inbound calls will be handled. Described here

Location

What physical office location is this user assigned to. This information is used for:

• Identifying what 911 information to send when the user dials 911

• When using location features such as Call Forward Location

Mailbox

Which mailbox will be the users primary mailbox.

Self:

If set to self we will create a mailbox specifically for the username if one does not exist, and then assign that mailbox.

None:

The user will not have voicemail

Any other value:

The selected mailbox will be assigned to the user.

A users primary mailbox is given special consideration.

• Only the primary mailbox is checked when dialing in via *86

• Only messages in the primary mailbox will activate MWI indicators on their devices

Email to send notifications

This is described in detail here

Email to send voice message

This is described in detail here

Fax Extension

Here you can assign the user to a fax service. This will enable sending of faxes from their portal and mobile application.

OnCall remind minutes

This is described in detail here

OnCall Remind Email

This is described in detail here

Outbound SMS Number

This is the number that SMS messages from the user will come from

Note

only matters if the user is SMS Enabled

Mobile Signaling

Controls what transport the RingRx mobile app uses. Unless you are certain about what you are doing, this should not be changed

Enable SMS

Controls if the user is allowed to send/receive SMS messages

SMS Auto Responder Enable

Enables automatic responses to inbound direct SMS messages.

SMS Auto Response text

What text should be sent in reply to an inbound sms

Important

SMS Auto responses are ONLY sent back to direct SMS messages. Group messages and internal messages will not receive an auto-response. We also limit each auto-response to 1 message every 30 seconds per phone number to prevent auto-response loops and spam

Call Recording

Controls if/when the users calls will be recorded

None:

None of the users calls will be recorded

Inbound:

Only Inbound calls TO the user will be recorded

Outbound:

Only outbound calls FROM the user will be recorded

Both:

All calls from or to the user will be recorded

Important

Consult local laws about call recording before setting this.

Play Recording Announcement

On inbound calls to the user, a prompt will be played indicating the call will be recorded.

Role

What permissions the user will have

User:

The user may login as themselves to the portal, use the mobile app and otherwise participate in the system

Admin:

The user has all the rights of a user but also has access to control the account settings and create/delete configurations

Fax:

This is ONLY used for accounts bound to a fax machine. This should not be set manually

Mailbox delegations

Here you can delegate other users mailboxes to this user.

This is described here

Two Factor Authentication

When OTP Required for Login is enabled the user must supply a one-time passcode in addition to their password when authenticating. See API Authentication for how this affects token requests.

Billing Contact

Flags the user as a billing contact for the account. Billing related notifications will be directed to flagged users.

API Keys

Each user can generate one or more API keys to authenticate to the RingRx API without using their username and password. This is the recommended method for machine-to-machine integrations, scripts and any unattended automation, since it avoids embedding user login credentials and can be revoked independently of the user’s password.

An API key is made up of two parts:

Token:

A public identifier for the key. The token is always visible and is used to identify the key when listing or deleting it.

Secret:

The private half of the key, used together with the token to authenticate.

Important

The secret is only returned once, at the moment the key is created. It is never shown again and cannot be retrieved later. Store it securely as soon as it is generated. If the secret is lost, delete the key and create a new one.

API keys are tied to the user that created them and inherit that user’s role and permissions. A key created by an Admin user can perform admin actions; a key created by a standard User is limited to that user’s own scope. Revoking a user, or deleting the key, immediately invalidates it.

Managing API Keys

API keys are managed under the logged in user’s own settings (“My Phone”). The following operations are available and are documented in detail in Swagger:

List keys:

GET /myphones/api_key returns an array of the current user’s keys. Only the token is returned for existing keys; secrets are never included.

Create a key:

POST /myphones/api_key with a name in the body creates a new key and returns the token and secret. This is the only time the secret is exposed.

Delete a key:

DELETE /myphones/api_key/{token} revokes the key identified by the token. Any integration using that key will immediately stop authenticating.

For instructions on exchanging a token and secret for an access token, see API Authentication.