The channel to send the code. Supported values: sms, push, whatsapp, voice, email.
digits
integer
No
The length of the code (min 4, max 10). default: 5.
expiry
integer
No
The expiry in seconds (min 10, max 3600). default: 60 seconds.
Parameters for channel sms or push
Parameter
Type
Required
Description
from
string
Yes
The number or name of the sender. This must be a valid phone number in E.164 format or an alphanumeric string between 3 and 11 characters. Please note that alphanumeric senders are not supported in all countries.
to
string
Yes
The receiver of the code. This must be a valid phone number in E.164 format.
message
string
No
Set a custom message. You can use the placeholder {code}, this will be replaced by the actual code.
Example: Your code is: {code}.
pushAppKey
string
When channel is push
The app key.
Parameters for channel whatsapp
Parameter
Type
Required
Description
from
string
Yes
The number or name of the sender. This must be a valid phone number in E.164 format or an alphanumeric string between 3 and 11 characters. Please note that alphanumeric senders are not supported in all countries.
to
string
Yes
The receiver of the code. This must be a valid phone number in E.164 format.
message
string
No
Set a custom message. You can use the placeholder {code}, this will be replaced by the actual code.
Example: Your code is: {code}. This is only used as a fallback in case the message could not be delivered via WhatsApp.
locale
string
No
The locale of the message. This must match with configured locales for the template.
Parameters for channel voice
Parameter
Type
Required
Description
from
string
Yes
The number of the sender. This must be a valid phone number in E.164 format.
to
string
Yes
The number of the receiver. This must be a valid phone number in E.164 format.
locale
string
No
Set the spoken language in the voice call. Supported values: de-DE, en-AU, en-GB, en-IN, en-US, es-ES, fr-CA, fr-FR, it-IT, ja-JP, nl-NL
Default: en-GB
anonymous
boolean
No
Set whether the number of the caller (from) is hidden in the voice call.
Default: false
message
string
No
Set a custom message to be used in the voice call. Do not include the {code} placeholder.
Parameters for channel email
Parameter
Type
Required
Description
to
string
Yes
The email address of the receiver.
locale
string
No
The locale for the email template.
message
string
No
Set a custom message to be used in the email message. Do not include the {code} placeholder.
