Tencent Cloud SMS gateway interface (China only).

In order to use Tencent Cloud to send SMS messages from AMPAREX the following settings are necessary.

Please note that you have to apply the settings on both AMPAREX and Tencent Cloud.

1. Tencent Cloud setup

  • You would then need to wait  for your company our yourself to be verified by Tencent Cloud.
  • Once verified you can go ahead and create a project under "Products" → "Communication" → "Short Message Service". This will enable you to use the Tencent Cloud platform to send SMS messages. Please note that the below screenshots are from the international version of Tencent Cloud. The Chinese web page could differ.

  • Please make sure you that your "Project" would be for messaging to mainland China. At this stage you'll obtain your unique "SDK AppID" and "APP Key" you would need to enter it later onto AMPAREX to further configure the SMS interface there.


  • The next step is to create your SMS message template on Tencent Cloud. You would need to create your SMS Signature as well as this is what would be displayed on the recipient phone when an SMS message gets sent to your patient(s).

The sample template could look like the below example:

We are looking forward to seeing you {1} at {2} o'clock! Best regards {3}

The same template saved on AMPAREX would look like this.

TemplateID: 351713
Params: [
   <span placeholder="true">/appointment/startdate</span>,
   <span placeholder="true">/appointment/starttime</span>,
   <span placeholder="true">login/staff/fullname</span>
]

Text:
We are looking forward to seeing you <span placeholder="true">/appointment/startdate</span> at <span placeholder="true">/appointment/starttime</span> o'clock!
Best regards <span placeholder="true">login/staff/fullname</span>

You would still need the fully functional AMPAREX placeholders in order to add customer related info onto your SMS message. Please note that on Tencent Cloud AMPAREX placeholders would need to be replaced by numbers placed in the curly brackets {1}. This means that the order of placeholders added on AMPAREX is not random, in our example:
{1} equals <span placeholder="true">/appointment/startdate</span>
{2} equals <span placeholder="true">/appointment/starttime</span>
{3} equals <span placeholder="true">login/staff/fullname</span>

It is mandatory to keep the above template formatting on AMPAREX. It has to follow the pattern starting with the "TemplateID". The placeholders need to be separated by commas in order to work. The numbers in the curly brackets on Tencent Cloud must follow the order of placeholders on AMPAREX.

The text of your SMS message will come from the Tencent Cloud template. We only display it on AMPAREX to visualise it.

  • After editing and saving your SMS template will be pending Tencent Cloud approval. From our experience it can take up to a few hours. As soon as it gets approved you'll be able to use it.

2. Settings on AMPAREX

Configuration

BranchYou can limit the service to a certain branch only.
PC/workstationYou can limit the service to a certain computer only. If no computer is selected, each computer may use the service.
Utilisation
  •  
StartYou can specifying a start date for the selected interface to start automatically. With no date selected the interface is ready for use straight away.

SMS Details

User nameYou will receive it from the provider. It will be called “SDK AppID”.
Sender

Here you can specify the sender’s name. This what the SMS recipient will see displayed on his/her smartphone. Please clarify the usage of special characters with the Tencent Cloud support.

Proxy ServerThe provider’s unique URL. This is already selected for you because it's always the same for a selected provider.
Check login dataPressing this button sends a query to your SMS API provider to check if the credentials you’ve entered are correct.
PasswordWill be communicated to you by the service provider and it called "App Key" here.
Country codePlease select 86 valid for People's Republic of China.

3. Additional info about SMS API on Tencent Cloud

Tencent Cloud has 4 main SMS service areas which contain different APIs. We currently use those marked in bold.

  • SMS text message APIs
    • Send single SMS message with specified template
    • Send bulk SMS messages with specified template
    • SMS message delivery status notification
    • SMS message reply
    • Pull SMS message status
    • Pull SMS message status of a single mobile number
  • Template APIs
    • Add SMS message template
    • Modify SMS message template
    • Delete SMS message template
    • Query SMS message template status
  • Signature APIs
    • Add SMS signature
    • Modify SMS signature
    • Delete SMS signature
    • Query SMS signature status
  • Statistics APIs
    • Delivery statistics
    • Report statistics