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:

  • 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
  • TotalVoice
    • Type: TotalVoice
    • AccessToken: the access token, provided by TotalVoice (e.g.: 0123456789abcdef0123456789abcdef)
  • 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)
  • SmsEmpresa
    • Type: SmsEmpresa
    • ChaveKey: the Chave Key given on Configuration > My Account
  • 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
  • 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.
  • 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": "..."
    },
    ...

See also