Edit on GitHub

Configure SMS sending - Amplia

If users will issue certificates (either web or mobile issuing procedure), a SMS confirmation is required to confirm the identity of the user during the certificate issue procedure.

The section SMS of the configuration file configures the SMS sending. SMS messages may be sent using different providers. The setting Type defines which provider should be used, and the remaining settings depend on the provider chosen:

  • Amazon SNS
    • Type: AmazonSNS
    • Region: the AWS region code, for instance sa-east-1 or us-east-1 (see AWS region codes)
    • AccessKeyId: the access key ID
    • SecretAccessKey: the secret access key
  • Comtele
    • Type: Comtele
    • AuthToken (required): API authentication token
    • Sender (optional): field Sender (see service documentation for more details)
    • Endpoint (default: https://sms.comtele.com.br/api/): fill to use a custom API endpoint (please note that the suffix v2/send is automatically added after the endpoint).
  • Eyou
    • Type: Eyou
    • ApiKey (required): API key acquired from service dashboard
    • Username (required): username field acquired from service dashboard
    • Password (required): password field acquired from service dashboard
    • UserAgent (optional): user agent header value to be passed on the API. Be default, a string containing the name and version of the application is sent.
    • CostCenter (optional): CostCenter field to be passed on the API
    • Endpoint (default: https://sendsms.eyou.com.br/api/sendSms): fill to use a custom API endpoint.
  • Generic
    • Type: Generic
    • Endpoint: the endpoint to which the SMS information will be sent.
    • AuthType (default: NoAuth): defines the type of authorization provided in the request. Available options are NoAuth, Basic, Bearer and ApiKey.
    • Username: the username if the AuthType is Basic.
    • Password: the password if the AuthType is Basic.
    • BearerToken: the Bearer token if the AuthType is Bearer.
    • ApiKey: the API key if the AuthType is ApiKey.
  • Pontaltech
    • Type: for OTP/token delivery purposes use FastPontaltech, for other purposes (e.g. marketing or general notifications) use Pontaltech
    • User (required): user field acquired from service dashboard
    • Password (required): password field acquired from service dashboard
    • Endpoint (default: sms-api-pointer.pontaltech.com.br): hostname to be used when calling the API (the actual route is not configurable).
  • SMS Empresa
    • Type: SmsEmpresa
    • ChaveKey: the Chave Key given on Configuration > My Account
  • SMS Token
    • Type: SmsToken
    • Key (required): API key acquired from service dashboard
    • Endpoint (default: https://api.smstoken.com.br/): fill to use a custom API endpoint (the actual route is not configurable).
  • Total Voice
    • Type: TotalVoice
    • AccessToken: the access token, provided by TotalVoice (e.g.: 0123456789abcdef0123456789abcdef)
  • Twilio
    • Type: Twilio
    • MessageFrom: the sender phone number provided by Twilio (e.g.: +12125550000)
    • AccountSid: the account SID, provided by Twilio
    • AuthToken: the authentication token, provided by Twilio
  • Zenvia
    • Type: Zenvia
    • Account: your account name (e.g.: patorum.sms)
    • Password: the API password
    • Endpoint (optional): alternative API base URL (leave blank if unsure)
  • Email dump (for debugging purposes only): this provider simulates the sending of SMS messages by sending them as email messages. The destination number is used as the mailbox (without the leading +) and the default domain is mailinator.com. For instance, a SMS message to the number +1 212 555-0001 would be instead be sent as an email message to 12125550001@mailinator.com.
    • Type: EmailDump
    • Domain: the domain to be used. The default domain is mailinator.com, but other disposable email domains may be used (e.g. grr.la)
    • EmailSender: the email sender to be used. By default, the default mail sender is used. This is normally not changed.
    • UseDefaultNamedEmailSender: set to true to use the unnamed mail sender. This is normally not changed.
  • Simulator (for debugging purposes only): this provider simulates the sending of SMS messages by outputting the messages that would be sent on the system log
    • Type: Simulator

Example (.ini or .conf configuration file):

[SMS]
Type=AmazonSNS
Region=us-east-1
AccessKeyId=...
SecretAccessKey=...

Example (environment variables):

SMS__Type=AmazonSNS
SMS__Region=us-east-1
SMS__AccessKeyId=...
SMS__SecretAccessKey=...

Example (.json configuration file):

    ...,
    "SMS": {
        "Type": "AmazonSNS",
        "Region": "us-east-1",
        "AccessKeyId": "...",
        "SecretAccessKey": "..."
    },
    ...

Using multiple SMS sending services

To configure multiple SMS sending services, define named subsections of the SMS section and define a Priority for each service. Lower values mean higher priority.

Example (.ini or .conf configuration file):

[SMS:AmazonUS]
Type=AmazonSNS
Region=us-east-1
AccessKeyId=...
SecretAccessKey=...
Priority=1

[SMS:AmazonSA]
Type=AmazonSNS
Region=sa-east-1
AccessKeyId=...
SecretAccessKey=...
Priority=2

[SMS:Fallback]
Type=Twilio
MessageFrom=...
AccountSid=...
AuthToken=...
Priority=3

Example (environment variables):

SMS__AmazonUS__Type=AmazonSNS
SMS__AmazonUS__Region=us-east-1
SMS__AmazonUS__AccessKeyId=...
SMS__AmazonUS__SecretAccessKey=...
SMS__AmazonUS__Priority=1

SMS__AmazonSA__Type=AmazonSNS
SMS__AmazonSA__Region=sa-east-1
SMS__AmazonSA__AccessKeyId=...
SMS__AmazonSA__SecretAccessKey=...
SMS__AmazonSA__Priority=2

SMS__Fallback__Type=Twilio
SMS__Fallback__MessageFrom=...
SMS__Fallback__AccountSid=...
SMS__Fallback__AuthToken=...
SMS__Fallback__Priority=3

In the example above, first the primary AmazonUS service would be used (Priority=1), then if it fails the secondary service AmasonSA would be used (Priority=2) and then the Fallback service would be used (Priority=3).

Note

In order for a secondary service to be used, the provider must report an error. Some providers report success even though the message delivery is internally rejected. In this case, the application cannot know that the delivery failed and thus the secondary provider is not used.

See also