ACI Documentation

SMS Accounts

Executive Summary

SMS Accounts is the setup list of text-messaging accounts that the system can send SMS messages from. Administrators add the sending phone number, choose the provider (Twilio) and enter the provider's authentication details. A test message can be sent from any account to confirm that it works. Credentials are stored encrypted.

Key Features

  • Add and edit SMS accounts (phone number, provider, Twilio Account SID and Auth Token)
  • Delete an account after confirmation
  • Send a test message from a selected account to any recipient number

Typical Workflow

  1. Click Add, enter the Phone Number, choose the Provider, and enter the Account SID and Auth Token, then click Save.
  2. Select the new row and click Send Test Message (or right-click the row and choose Send Test Message).
  3. Enter the Recipient Number and click Ok.
  4. Check the confirmation message: "SMS Message sent" or "Sending SMS Message failed".

Available Permissions

The following permissions are available to be assigned to AlayaCare Roles:

AttributeWhat It Controls
ViewOpen the page
EditAdd and edit SMS accounts. Without it, Add and Edit show a warning that you are not authorized.

Main Grid

The grid lists the SMS accounts (14 rows per page).

ColumnDescription
Phone NumberPhone number the messages are sent from.
ProviderSMS provider.
Manage RecordsEdit icon and a delete (close) icon for the row.

Actions

ButtonDescription
AddOpens the SMS Account dialog to create an account (requires the Edit permission).
Send Test MessageOpens the Send Test Message dialog for the selected row. Nothing happens if no row is selected.
Edit icon / right-click EditOpens the selected account for editing (requires the Edit permission).
Delete icon / right-click DeleteAsks "Are you sure you want to delete this sms account?" and deletes the account on Yes.
Send Test Message (right-click a row)Opens the Send Test Message dialog for that row.

Dialog Components

SMS Account

Opens from Add or edit. Save stores the account; Cancel closes without saving. The Phone Number can only be entered when the account is created. For Twilio, the phone number, Account SID and Auth Token are all required.

FieldPurpose
Phone NumberNumber the messages are sent from. Read-only when editing.
ProviderSMS provider. Only Twilio is available.
Account SIDTwilio account identifier (shown under Authentication when Twilio is selected).
Auth TokenTwilio authentication token (shown under Authentication when Twilio is selected).

Send Test Message

Opens from Send Test Message.

FieldPurpose
Recipient NumberPhone number that receives the test message.

Ok sends the message "This is a Test Message from ACIntegrations" from the selected account; Cancel closes the dialog.

Processing Overviews

This section describes what happens after you confirm a processing action.

Send Test Message

  1. Checks that the selected account has a phone number, Account SID and Auth Token; a warning is shown for any that is missing.
  2. Sends the test message to the Recipient Number through Twilio.
  3. Shows "SMS Message sent" on success or "Sending SMS Message failed" if the message could not be sent, then closes the dialog.