Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Summary

Twilio leverages web services that are exposed in ClinSpark in order to communicate scenarios when phone calls and SMS messages are sent and received. In order for this to happen, a given Twilio account must have a configured ‘TwiMLApp’. This guide providers a user the configuration settings in Twilio and what must take place in ClinSpark.

Twilio Account Setup

These steps assume that a customer has created a Twilio account and has logged in to the management dashboard.

(Customer) Reserve a Number

If a new phone number is required for this use case, use Twilio’s admin UI to provision it.  Note the number provisioned.

...

(Customer) Add Foundry Support as a admin user

Please add stuart.robertson@foundryhealth.com and for support purposes. We may add additional internal support users as needed, though this is cost neutral. We will use this access only to configure and manage integration with your ClinSpark instance.

...

(For Foundry Support) Create a TwiML App

A TwiML app binds a phone number to application endpoints such as webhooks.  Create a new app or re-purpose another if that’s no longer used.

From the Number menu, click the ‘Tools’, TwiML Apps and then the  ‘Add’ icon.

  1. Image AddedImage Added

    Note the SID, this is the Application SID to be configured in ClinSpark later

  2. Ensure that the ‘optional’ settings are shown

  3. Replace the ‘YOUR_CLINSPARK_DOMAIN’ with the subdomain used to interact with ClinSpark. Ensure the URLs are otherwise the same

(For Foundry Support) Configure Number to Use TwiML App

  1. Image Added

    Ensure that the voice and messaging sections are configured with the configured TwiML App

(For Foundry Support) ClinSpark Instance Setup

Ensure that Twilio Support is enabled in ClinSpark. This can only be done by a Foundry Health ‘superadmin’ account. If necessary, reach out to Foundry Health via the support service desk for assistance with this setting.

...

(For Foundry Support) Twilio Settings in ClinSpark

Note, this can only be done by a Foundry Health ‘superadmin’ account.

  1. Image AddedImage Added

    TwiML Application ID from previous step

  2. The default country prefix as defined here: List of country calling codes