Dynamic Routes Reference documentation

From voipsupport
Revision as of 17:35, 11 June 2016 by John (talk | contribs) (Created page with " !!Configuration Settings (:table border=1 cellpadding=5 cellspacing=0:) (:head:) Name (:head:) Value (:cellnr:) Name (:cell:) The name of the dynamic route. This can be chos...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

!!Configuration Settings

(:table border=1 cellpadding=5 cellspacing=0:) (:head:) Name (:head:) Value (:cellnr:) Name (:cell:) The name of the dynamic route. This can be chosen at will. It is used to identify the route when selecting it as a destination from other applications or inbound routes. (:cellnr:) Get DTMF Input (:cell:) Whether the channel should stop and wait for DTMF input. This can be useful if the caller must enter a number (e.g. customer number) which will then be used in the database query. Note the input is available within the database query using the special string [INPUT] (:cellnr:) Timeout (:cell:) Timeout in seconds to wait for DTMF input. This value is only used if Get DTMF Input is checked. If no value is given, the default for the channel is used. It is best to set an explicit value to avoid doubts (:cellnr:) Input Variable (:cell:) Optional variable name which will store the DTMF Input for later use. This is not needed if you will use the DTMF input only within the query (where it may be referred to by the special variable [INPUT]), but only if the call is passed to a further dynamic route or dial plan application where the input needs to be available (:cellnr:) Announcement (:cell:) The announcement to play. If DTMF input is checked, this annoucement plays before waiting for the input (:cellnr:) Host (:cell:) Host name or ip address of the database server (:cellnr:) Database (:cell:) Name of the database (:cellnr:) Username (:cell:) Username with which to connect to the database (:cellnr:) Password (:cell:) Password for the username (:cellnr:) Query (:cell:) Query to execute. With the query certain predefined strings are substituted (see below) (:cellnr:) Result Variable (:cell:) Optional variable name which will store the result of the query for later use. This is not needed if you will use it only within this dynamic route to match strings in the option section in order to select the destination. However if the call is passed to a further dynamic route or dial plan application where the result needs to be available, then use this field to define the name of the variable that will hold the query result. (:cellnr:) Options (:cell:) Each line defines a value to be matched and a destination to use if the value is matched. Field 1: matched value. This must be an exact match. Field 2: destination type. Field 3: Destination name. A special value default can be used in Field 1 as a catchall to match any other value than the ones specified. If default is not specified, it is implicitly assumed, with the default action on no match being to hang up the call. Where you want a different default action, you should explicitly define the destination for default. (:tableend:)

!!Variable substitutions

(:table border=1 cellpadding=5 cellspacing=0:) (:head:) Variable name (:head:) Where used (:head:) Purpose (:cellnr:) [INPUT] (:cell:) Query (:cell:) DTMF input by caller (:cellnr:) [NUMBER] (:cell:) Query (:cell:) the callerid (:cellnr:) [DID] (:cell:) Query (:cell:) the called number (:cellnr:) [xxx] (:cell:) Query / Dialplan (:cell:) where xxx is the name of an Input or Result Variable defined in the configuration. In the case of an input variable, it contains the DTMF input by the user. In the case of a Result variable it contains the value returned by the query. When used in the dialplan the name of the variable is prefixed by DYNROUTE_, e.g. DYNROUTE_xxx (:tableend:)