configs/ccss.conf.sample

   1 ;
   2 ; --- Call Completion Supplementary Services ---
   3 ;
   4 ; For more information about CCSS, see the CCSS user documentation
   5 ; https://wiki.asterisk.org/wiki/display/AST/Call+Completion+Supplementary+Services+(CCSS)
   6 ;
   7
   8 [general]
   9 ; There is only a single option that may be defined in this file.
  10 ; The cc_max_requests option is a global limit on the number of
  11 ; CC requests that may be in the Asterisk system at any time.
  12 ;
  13 ;cc_max_requests = 20
  14 ;
  15 ;
  16 ;============================================
  17 ;           PLEASE READ THIS!!!
  18 ; The options described below should NOT be
  19 ; set in this file. Rather, they should be
  20 ; set per-device in a channel driver
  21 ; configuration file.
  22 ;           PLEASE READ THIS!!!
  23 ;===========================================
  24 ;
  25 ;---------------------------------------------------------------------
  26 ;                                Timers
  27 ;---------------------------------------------------------------------
  28 ;There are three configurable timers for all types of CC: the
  29 ;cc_offer_timer, the ccbs_available_timer, and the ccnr_available_timer.
  30 ;In addition, when using a generic agent, there is a fourth timer,
  31 ;the cc_recall_timer. All timers are configured in seconds, and the
  32 ;values shown below are the defaults.
  33 ;
  34 ;When a caller is offered CCBS or CCNR, the cc_offer_timer will
  35 ;be started. If the caller does not request CC before the
  36 ;cc_offer_timer expires, then the caller will be unable to request
  37 ;CC for this call.
  38 ;
  39 ;cc_offer_timer = 20
  40 ;
  41 ;Once a caller has requested CC, then either the ccbs_available_timer
  42 ;or the ccnr_available_timer will run, depending on the service
  43 ;requested. The reason why there are two separate timers for CCBS
  44 ;and CCNR is that it is reasonable to want to have a shorter timeout
  45 ;configured for CCBS than for CCNR. If the available timer expires
  46 ;before the called party becomes available, then the CC attempt
  47 ;will have failed and monitoring of the called party will stop.
  48 ;
  49 ;ccbs_available_timer = 4800
  50 ;ccnr_available_timer = 7200
  51 ;
  52 ; When using a generic agent, the original caller is called back
  53 ; when one of the original called parties becomes available. The
  54 ; cc_recall_timer tells Asterisk how long it should let the original
  55 ; caller's phone ring before giving up. Please note that this parameter
  56 ; only affects operation when using a generic agent.
  57 ;
  58 ;cc_recall_timer = 20
  59 ;---------------------------------------------------------------------
  60 ;                                Policies
  61 ;---------------------------------------------------------------------
  62 ; Policy settings tell Asterisk how to behave and what sort of
  63 ; resources to allocate in order to facilitate CC. There are two
  64 ; settings to control the actions Asterisk will take.
  65 ;
  66 ; The cc_agent_policy describes the behavior that Asterisk will
  67 ; take when communicating with the caller during CC. There are
  68 ; three possible options.
  69 ;
  70 ;never:   Never offer CC to the caller. Setting the cc_agent_policy
  71 ;         to this value is the way to disable CC for a call.
  72 ;
  73 ;generic: A generic CC agent is one which uses no protocol-specific
  74 ;         mechanisms to offer CC to the caller. Instead, the caller
  75 ;         requests CC using a dialplan function. Due to internal
  76 ;         restrictions, you should only use a generic CC agent on
  77 ;         phones (i.e. not "trunks"). If you are using phones which
  78 ;         do not support a protocol-specific method of using CC, then
  79 ;         generic CC agents are what you should use.
  80 ;
  81 ;native:  A native CC agent is one which uses protocol-specific
  82 ;         signaling to offer CC to the caller and accept CC requests
  83 ;         from the caller. The supported protocols for native CC
  84 ;         agents are SIP, ISDN ETSI PTP, ISDN ETSI PTMP, and Q.SIG
  85 ;cc_agent_policy=never
  86 ;
  87 ; The cc_monitor_policy describes the behavior that Asterisk will
  88 ; take when communicating with the called party during CC. There
  89 ; are four possible options.
  90 ;
  91 ;never:   Analogous to the cc_agent_policy setting. We will never
  92 ;         attempt to request CC services on this interface.
  93 ;
  94 ;generic: Analogous to the cc_agent_policy setting. We will monitor
  95 ;         the called party's progress using protocol-agnostic
  96 ;         capabilities. Like with generic CC agents, generic CC
  97 ;         monitors should only be used for phones.
  98 ;
  99 ;native:  Analogous to the cc_agent_policy setting. We will use
 100 ;         protocol-specific methods to request CC from this interface
 101 ;         and to monitor the interface for availability.
 102 ;
 103 ;accept:  If an interface is set to "accept," then we will accept
 104 ;         protocol-specific CC offers from the caller and use
 105 ;         a native CC monitor for the remainder of the CC transaction.
 106 ;         However, if the interface does not offer protocol-specific
 107 ;         CC, then we will fall back to using a generic CC monitor
 108 ;         instead. This is a good setting to use for phones for which
 109 ;         you do not know if they support protocol-specific CC
 110 ;         methodologies.
 111 ;cc_monitor_policy=never
 112 ;
 113 ;
 114 ;---------------------------------------------------------------------
 115 ;                              Limits
 116 ;---------------------------------------------------------------------
 117 ;
 118 ; The use of CC requires Asterisk to potentially use more memory than
 119 ; some administrators would like. As such, it is a good idea to limit
 120 ; the number of CC requests that can be in the system at a given time.
 121 ; The values shown below are the defaults.
 122 ;
 123 ; The cc_max_agents setting limits the number of outstanding CC
 124 ; requests a caller may have at any given time. Please note that due
 125 ; to implementation restrictions, this setting is ignored when using
 126 ; generic CC agents. Generic CC agents may only have one outstanding
 127 ; CC request.
 128 ;
 129 ;cc_max_agents = 5
 130 ;
 131 ; The cc_max_monitors setting limits the number of outstanding CC
 132 ; requests can be made to a specific interface at a given time.
 133 ;
 134 ;cc_max_monitors = 5
 135 ;
 136 ;---------------------------------------------------------------------
 137 ;                            Other
 138 ;---------------------------------------------------------------------
 139 ;
 140 ; When using a generic CC agent, the caller who requested CC will be
 141 ; called back when a called party becomes available. When the caller
 142 ; answers his phone, the administrator may opt to have a macro run.
 143 ; What this macro does is up to the administrator. By default there
 144 ; is no callback macro configured.
 145 ;
 146 ;cc_callback_macro=
 147 ;
 148 ; When using an ISDN phone and a generic CC agent, Asterisk is unable
 149 ; to determine the dialstring that should be used when calling back
 150 ; the original caller. Furthermore, if you desire to use any dialstring-
 151 ; specific options, such as distinctive ring, you must set this
 152 ; configuration option. For non-ISDN phones, it is not necessary to
 153 ; set this, since Asterisk can determine the dialstring to use since
 154 ; it is identical to the name of the calling device. By default, there
 155 ; is no cc_agent_dialstring set.
 156 ;
 157 ;cc_agent_dialstring=