Dialplan Application

Dialplan Application

This usage mode allows for module actions to be performed at specific points of a dialplan execution. The syntax is straight forward:

  <action application="phonenumber" data="<action(s)> <scope> [parameter(s)]"/>
  • actions - the implementation accepts one or more (comma separated) actions to be executed;
  • scope - represents the input the actions will be executed against; it can be set to caller, destination, all or an actual number (likely by expanding a previously set variable);
  • parameters - one or more (comma separated) parameters the actions will have to observe. When omitted, default values will be inferred from module’s configuration;

In this usage mode, the actions’ output will be returned in the form of channel variables; their naming is dictated by the responsible action as well as the scope. The table below outlines the channel variable names based on the executed action and the scope:

ActioncallerdestinationNumber
is_alpha_numberphonenumber_caller_is_alpha_numberphonenumber_destination_is_alpha_numberphonenumber_number_is_alpha_number
convert_alpha_characters_in_numberphonenumber_caller_alpha_characters_in_numberphonenumber_destination_alpha_characters_in_numberphonenumber_number_alpha_characters_in_number
normalize_digits_onlyphonenumber_caller_digits_onlyphonenumber_destination_digits_onlyphonenumber_number_digits_only
normalize_diallable_chars_onlyphonenumber_caller_diallable_chars_onlyphonenumber_destination_diallable_chars_onlyphonenumber_number_diallable_chars_only
get_national_significant_numberphonenumber_caller_national_significant_numberphonenumber_destination_national_significant_numberphonenumber_number_national_significant_number
format_out_of_country_calling_numberphonenumber_caller_out_of_country_calling_numberphonenumber_destination_out_of_country_calling_numberphonenumber_number_out_of_country_calling_number
formatphonenumber_caller_formatphonenumber_destination_formatphonenumber_number_format
get_number_typephonenumber_caller_number_typephonenumber_destination_number_typephonenumber_number_number_type
is_valid_number_for_regionphonenumber_caller_valid_number_for_regionphonenumber_destination_valid_number_for_regionphonenumber_number_valid_number_for_region
get_region_codephonenumber_caller_region_codephonenumber_destination_region_codephonenumber_number_region_code
is_possible_number_with_reasonphonenumber_caller_is_possible_number_with_reasonphonenumber_destination_is_possible_number_with_reasonphonenumber_number_is_possible_number_with_reason
is_possible_numberphonenumber_caller_is_possible_numberphonenumber_destination_is_possible_numberphonenumber_number_is_possible_number
get_description_for_numberphonenumber_caller_description_for_numberphonenumber_destination_description_for_numberphonenumber_number_description_for_number