Pular para o conteúdo principal

SMS sending

When SMS sending is enabled (electronic signature with a code via SMS), Signer needs an account with one of the supported SMS providers. The parameters live in the SMS section of the instance settings (see Signer settings).

Basic configuration

To enable it, set Enabled to true, pick the provider in Type and fill in its credentials:

{
"SMS": {
"Enabled": true,
"Type": "Twilio",
"MessageFrom": "+12125550000",
"AccountSid": "AC00000000000000000000000000000000",
"AuthToken": "ffffffffffffffffffffffffffffffff"
}
}

With Total Voice, for example:

{
"SMS": {
"Enabled": true,
"Type": "TotalVoice",
"AccessToken": "0123456789abcdef0123456789abcdef"
}
}
note

Type is case-sensitive and must be one of the values in the table below. Every provider has an optional Endpoint property, used only to point to an alternative environment (staging or a proxy); leave it out to use the provider's default endpoint.

Supported providers

ProviderTypeParameters
TwilioTwilioAccountSid, AuthToken, MessageFrom (or MessagingServiceSid)
Total VoiceTotalVoiceAccessToken
ComteleComteleSender, AuthToken
ZenviaZenviaAccount, Password
PontaltechPontaltechUser, Password
Pontaltech (fast route)FastPontaltechUser, Password
SMS EmpresaSmsEmpresaChaveKey
SMS TokenSmsTokenKey
TigoTigoApiKey
EyouEyouUsername, Password, ApiKey, CostCenter
Amazon SNSAmazonSnsRegion, AccessKeyId, SecretAccessKey
Generic (HTTP)GenericEndpoint, AuthType (NoAuth, Basic, Bearer, ApiKey) and the credentials for the chosen mode
Simulator (testing)Simulatornone. Only logs the send, without actually sending an SMS
Twilio

Besides the credentials, Twilio supports SMS pumping fraud protection. Prefer AccountSid + AuthToken over the old basic-credential pair.

Multiple providers by country

You can configure more than one provider and route between them by the destination number's international prefix, using EnabledPrefixes (a comma-separated list). Each provider goes in a named subsection:

{
"SMS": {
"Enabled": true,
"Brazil": {
"Type": "TotalVoice",
"AccessToken": "...",
"EnabledPrefixes": "+55"
},
"International": {
"Type": "Twilio",
"AccountSid": "...",
"AuthToken": "...",
"MessageFrom": "+12125550000",
"EnabledPrefixes": "+1,+54"
}
}
}

See also