Authenticate(password[,options,maxdigits,prompt])
Full arguments reference
passwordrequired - Password the user should know-
optionsa- Set the channels' account code to the password that is entered-
d- Interpret the given path as database key, not a literal file.Note
The value is not used at all in the authentication when using this option. If the family/key is set to
/pin/100(value does not matter) then the password field needs to be set to/pinand the pin entered by the user would be authenticated against100. -
m- Interpret the given path as a file which contains a list of account codes and password hashes delimited with:, listed one per line in the file. When one of the passwords is matched, the channel will have its account code set to the corresponding account code in the file. r- Remove the database key upon successful entry (valid withdonly)maxdigits- maximum acceptable number of digits. Stops reading after maxdigits have been entered (without requiring the user to press the#key). Defaults to 0 - no limit - wait for the user press the#key.prompt- Override the "agent-pass" sound file. Can be an ampersand separated list of filenames. If the filename is a relative filename (it does not begin with a slash), it will be searched for in the Asterisk sounds directory. If the filename is able to be parsed as a URL, Asterisk will download the file and then begin playback on it. To include a literal&in the URL you can enclose the URL in single quotes.promptrequiredprompt2(multiple)
This application asks the caller to enter a given password in order to continue dialplanThe core call-routing configuration of Asterisk, written mostly in extensions.conf as contexts, extensions, and priorities that decide how every call is handled. Full definition → execution.
If the password begins with the / character, it is interpreted as a file which contains a list of valid passwords, listed 1 password per line in the file.
When using a database key, the value associated with the key can be anything.
Users have three attempts to authenticate before the channelA single call leg passing through Asterisk. Channels represent connections to endpoints and are what dialplan applications act on. is hung up.
passwordrequired - Password the user should know-
optionsa- Set the channels' account code to the password that is entered-
d- Interpret the given path as database key, not a literal file.Note
The value is not used at all in the authentication when using this option. If the family/key is set to
/pin/100(value does not matter) then the password field needs to be set to/pinand the pin entered by the user would be authenticated against100. -
m- Interpret the given path as a file which contains a list of account codes and password hashes delimited with:, listed one per line in the file. When one of the passwords is matched, the channel will have its account code set to the corresponding account code in the file. r- Remove the database key upon successful entry (valid withdonly)maxdigits- maximum acceptable number of digits. Stops reading after maxdigits have been entered (without requiring the user to press the#key). Defaults to 0 - no limit - wait for the user press the#key.prompt- Override the "agent-pass" sound file. Can be an ampersand separated list of filenames. If the filename is a relative filename (it does not begin with a slash), it will be searched for in the Asterisk sounds directory. If the filename is able to be parsed as a URL, Asterisk will download the file and then begin playback on it. To include a literal&in the URL you can enclose the URL in single quotes.promptrequiredprompt2(multiple)
User Notes
Know a tip or gotcha for this topic? Share it below and help others.
Contribute a note
Share a tip, gotcha, or practical example. Keep it under 2000 characters. No questions (use the Asterisk community forums for support). Wrap code in backticks.