|
|
| (454 intermediate revisions by 18 users not shown) |
| Line 1: |
Line 1: |
| == Call object ==
| | {{DISPLAYTITLE:Routing Script Tutorial: Development Guide}} |
|
| |
|
| === Get === | | |
|
| |
|
| Those function are used to get the call parameters. The possible parameters are described in the section "Call parameters"
| | ==Introduction== |
| | This Routing Script Tutorial provides you with essential information in managing the routing of your calls. Consult the sections below to learn more. |
|
| |
|
| called_number = caf_call.get :called
| | {| class="wikitable" |
|
| |
|
| === List_params ===
| | |[[File:NoteIcon.png|100px]]|| An alternate version of this guide for routing scripts is available. [[Routing script tutorial|Consult it to enhance your learning.]] |
| | |} |
|
| |
|
| This function is used to retrieve the list of supported call parameters. For example to extract all the possible call params from the the call object and put it in hash.
| | ==Accessing Routing Script Parameters == |
| | [[Routing Script Tutorial: Accessing Routing Script Parameters|Learn how to access routing script parameters.]] |
|
| |
|
| caf_call.list_params.each {|param| call[param] = caf_call.get param }
| | ==Routing Script Parameter Mapping Table== |
| | [[Routing Script Parameter Mapping Table|Learn how each Routing Script Parameter maps to varying protocols.]] |
|
| |
|
| === Accept === | | ==Script Parameters Definition== |
| | [[Routing Script Tutorial: Script Parameters Definition|Learn about the definition of each script parameter.]] |
|
| |
|
| This function is used to accept a call. It takes 2 arguments, the call parameters (hash) and the route parameters (hash).
| | ==Script Parameters Definition for SIP== |
| | [[Routing Script Tutorial: Script Parameters Definition for SIP|Learn about the definition of each script parameter for SIP.]] |
|
| |
|
| Apply route remapping rules
| | ==Registered Users Information== |
| | [[Routing Script Tutorial: Registered Users Information|Learn how routing scripts access information about registered users.]] |
|
| |
|
| caf_call.accept out_call, route
| | ==Route Parameters and Call Routing== |
| | [[Routing Script Tutorial: Route Parameters and Call Routing|Learn about the standard parameters used in a call and how they route to registered users.]] |
|
| |
|
| === Refuse === | | ==Playing prompts announcements or tones== |
| | [[Routing Script Tutorial: Playing prompts announcements and tones|Learn how to play all sorts of media files for call prompts, announcements, and tones.]] |
|
| |
|
| This function is used to refuse a call with a reason code argument parameters :
| | ==Recording== |
| | [[Routing Script Tutorial: Recording|Learn how to use routing scripts to record incoming and/or outgoing call legs.]] |
|
| |
|
| caf_call.refuse :reason => :temporary_failure
| | ==User-to-User Information== |
| | [[Routing Script Tutorial: User-to-User Information|Learn how to use User-to-User Information (UUI) in routing scripts.]] |
|
| |
|
| The supported values are described in the section "Reason values".
| | ==Radius Autorization== |
| | [[Routing Script Tutorial: Radius Authorization|Learn how to send RADIUS authorization requests in routing scripts.]] |
|
| |
|
| == Call parameters == | | ==ENUM Query== |
| | [[Routing Script Tutorial: ENUM Query|Learn how to send ENUM Query requests to DNS servers in routing scripts.]] |
|
| |
|
| The following call parameters are available in the call object:
| | == DNS Query == |
| | [[Routing Script Tutorial: DNS Query|Learn how to send DNS Query requests to DNS servers in routing scripts.]] |
|
| |
|
| *calling
| | == Call Diversion Options == |
| *calling_noa
| | [[Routing Script Tutorial: Call Diversion Options|Learn how control a call flow with diversion options.]] |
| *calling_npi
| |
| *calling_display_type
| |
| *calling_display
| |
| *calling_presentation
| |
| *calling_screening
| |
| *calling_category
| |
| *private_display
| |
| *private_display_type
| |
| *private_address
| |
| *called
| |
| *called_noa
| |
| *called_npi
| |
| *charge_number
| |
| *charge_number_noa
| |
| *charge_number_npi
| |
| *redirecting_number_forward_enabled
| |
| *redirecting_number
| |
| *redirecting_number_noa
| |
| *redirecting_number_npi
| |
| *redirecting_number_presentation
| |
| *redirecting_number_screening
| |
| *redirecting_number_reason
| |
| *redirecting_number_counter
| |
| *original_called_number
| |
| *original_called_number_noa
| |
| *original_called_number_npi
| |
| *original_called_number_presentation
| |
| *original_called_number_screening
| |
| *original_called_number_reason
| |
| *original_called_number_counter
| |
| *ported_number
| |
| *ported_number_noa
| |
| *ported_number_npi
| |
| *nap
| |
| *oli
| |
| *request_uri
| |
| *request_uri_forward_enabled
| |
| *any sip_header (outgoing only)
| |
|
| |
|
| '''Notice:''' All values are documented in the '''noa_npi_remap.rb''' script and may change between major release.
| | == Call Transfer Requests == |
| | [[Routing Script Tutorial: Call Transfer Requests|Learn how to route call transfer requests.]] |
|
| |
|
| === Noa values === | | == Redirection == |
| | [[Routing Script Tutorial: Redirection|Learn how to get redirection contacts.]] |
|
| |
|
| *<tt>unknown_number</tt>
| | == Connected Number == |
| *<tt>international_number</tt>
| | [[Routing Script Tutorial: Connected Number|Connected Number]] |
| *<tt>national_number</tt>
| |
| *<tt>subscriber_number</tt>
| |
| *<tt>network_specific</tt>
| |
| *<tt>network_routing_national_format</tt>
| |
| *<tt>network_routing_international_format</tt>
| |
| *<tt>abbreviated_number</tt>
| |
| *<tt>subscriber_number_operator_requested</tt>
| |
| *<tt>national_number_operator_requested</tt>
| |
| *<tt>international_number_operator_requested</tt>
| |
| *<tt>no_number_present_operator_requested</tt>
| |
| *<tt>no_number_present_cut_through_call_to_carrier</tt>
| |
| *<tt>test_line_test_code</tt>
| |
| *<tt>non_unique_subscriber_number</tt>
| |
| *<tt>non_unique_national_number</tt>
| |
| *<tt>non_unique_international_number</tt>
| |
| *<tt>call_950_number</tt>
| |
|
| |
|
| Those values will be remapped to the protocol specific NOA value. To provide protocol specific value:
| | == Terminating Calls == |
| | [[Routing Script Tutorial: Terminating Calls|Learn how to terminate calls with routing scripts.]] |
|
| |
|
| *<tt>call_params[:called_noa] = 0x70</tt>
| | == NAP status and other NAP information == |
| | [[Routing Script Tutorial: NAP Status and other NAP Information|Learn how to use NAP status field in routing scripts.]] |
|
| |
|
| or
| | == Telephony Services (CNAM Request over SS7)== |
| | [[Routing Script Tutorial: CNAM Request|Learn how to manage CNAM requests over SS7.]] |
|
| |
|
| *<tt>call_params[:called_noa] = 112</tt>
| | == Custom User Context == |
| | [[Routing Script Tutorial: Custom User Context|Custom User Context]] |
|
| |
|
| === Npi values === | | == Routing Script Tests == |
| | | [[Routing Script Tutorial: Routing Script Tests|Learn how to use the Web Portal to test your routing scripts.]] |
| *<tt>unknown_number</tt>
| |
| *<tt>isdn</tt>
| |
| *<tt>telephony</tt>
| |
| *<tt>private</tt>
| |
| *<tt>data</tt>
| |
| *<tt>telex</tt>
| |
| *<tt>national</tt>
| |
| | |
| === Calling Display Type values ===
| |
| | |
| *<tt>unspecified</tt> => Type is unspecified.
| |
| *<tt>calling_party_name</tt> => Type is 0xB1.
| |
| | |
| Those values will be remapped to the protocol specific Display Information Type value. To provide protocol specific value:
| |
| | |
| *<tt>call_params[:calling_display_type] = 0xB1</tt>
| |
| | |
| or
| |
| | |
| *<tt>call_params[:calling_display_type] = 177</tt>
| |
| | |
| === Calling Display value ===
| |
| | |
| *<tt>call_params[:calling_display] = "Roger Fluffy"</tt>
| |
| | |
| === Presentation values ===
| |
| | |
| *<tt>unspecified</tt>
| |
| *<tt>not_available</tt>
| |
| *<tt>allowed</tt>
| |
| *<tt>restricted</tt>
| |
| *<tt>addr_restricted</tt>
| |
| *<tt>name_restricted</tt>
| |
| | |
| === Screening values ===
| |
| | |
| *<tt>unspecified</tt>
| |
| *<tt>no</tt>
| |
| *<tt>pass</tt>
| |
| *<tt>fail</tt>
| |
| *<tt>network_provided</tt>
| |
| | |
| === Redirecting number reason values ===
| |
| | |
| ISDN:
| |
| | |
| *<tt>unknown</tt>
| |
| *<tt>busy</tt>
| |
| *<tt>no_reply</tt>
| |
| *<tt>deflection</tt>
| |
| *<tt>dte_out_of_order</tt>
| |
| *<tt>forwarding_by_called_dte</tt>
| |
| *<tt>unconditional</tt>
| |
| | |
| SS7:
| |
| | |
| *<tt>unknown</tt>
| |
| *<tt>busy</tt>
| |
| *<tt>no_reply</tt>
| |
| *<tt>unconditional</tt>
| |
| *<tt>deflection</tt>
| |
| *<tt>deflection_immediate</tt>
| |
| *<tt>mobile_not_reachable</tt>
| |
| | |
| === OLI (originating line information) values ===
| |
| | |
| The OLI parameter is a string that represents an integer value from 0 to 255.
| |
| | |
| | |
| === redirecting_number_forward_enabled values ===
| |
| | |
| Controls forwarding or discarding of redirecting number (SIP: diversion header) to outgoing call leg.
| |
| | |
| Values for this parameter are "0", "1", "false" or "true. 0/false: Redirecting number (and original called number) is not forwarded to outgoing call leg 1/true: Redirecting number (and original called number) is forwarded to outgoing call leg The value for this parameter at input of routing script depends on the "Forward redirecting number" parameter in the "Advanced" section of the Gateway configuration page of the Web Portal. The script may change this value to override the Gateway configuration.
| |
| | |
| <br>
| |
| | |
| === request_uri ===
| |
| | |
| Enables access to the Request-Line URI.<br>
| |
| | |
| For example, if the Request-Line is:
| |
| <pre>Request-Line: INVITE sip:4175162082@172.22.45.13:5060;user=phone;transport=udp SIP/2.0</pre>
| |
| Then the retrieved request_uri will be "sip:4175162082@172.22.45.13:5060;user=phone;transport=udp SIP/2.0". <br>
| |
| | |
| In the routing scripts, to retrieve only the called number, this script can be used:<br>
| |
| <pre> if call_params[:request_uri] && call_params[:request_uri] =~ /sip:(.*)@.*/
| |
| call_params[:called] = $1
| |
| end
| |
| </pre>
| |
| | |
| === request_uri_forward_enabled values ===
| |
| | |
| Controls forwarding or discarding of request uri to outgoing call leg.The request uri is the information in the "Request-Line:" of the SIP INVITE message.<br>
| |
| | |
| Values for this parameter are "0", "1", "false" or "true. <br>
| |
| | |
| 0/false: Request uri is not forwarded to outgoing call leg <br>
| |
| | |
| 1/true: Request uri is forwarded to outgoing call leg <br>
| |
| | |
| The value for this parameter at input of routing script is always false.
| |
| <br>
| |
| | |
| == Route parameters ==
| |
| | |
| All route may have these parameters:
| |
| | |
| *calling
| |
| *called
| |
| *nap
| |
| *remapped_calling
| |
| *remapped_called
| |
| *remapped_nap
| |
| *remapped_profile
| |
| | |
| Additionally it is possible to add dynamic route attributes in the web portal. These can be referenced by their name.
| |
| | |
| == Bridge parameters ==
| |
| | |
| New feature in release 2.6, all bridges may have these parameters:
| |
| | |
| *announcement_tone
| |
| *call_progress_tone
| |
| *ring_tone
| |
| *max_call_duration
| |
| *call_duration_reason
| |
| *disconnect_tone
| |
| *uui
| |
| *uui_forward_enabled
| |
| | |
| === tone string format ===
| |
| | |
| All tone strings (:announcement_tone, :call_progress_tone, :ring_tone, :disconnect_tone) inside bridge parameters are using this format.
| |
| <br>"file1.wav:repeat:start_off:end_off,file2.wav:repeat:start_off:end_off,file3.wav:repeat:start_off:end_off"
| |
| <br>optional repeat parameter: number of times to play the file (0 and 1 have the same result)
| |
| <br>optional start_off parameter : Start offset in milliseconds
| |
| <br>optional end_off parameter: End offset in milliseconds
| |
| <br>
| |
| <br>Example: "file1.wav,file2.wav:-1" will play file1.wav one time and then play file2.wav in loop.
| |
| <br>Example: "file1.wav:0:1000:3000,file2.wav:2:5000:10000" will play file1.wav from second 1 to second 3 then file2.wav from second 5 to second 10 two times.
| |
| <br>Example: "file1.wav:0:0:30000" will play file1.wav one time for a max duration of 30 seconds.
| |
| | |
| === announcement_tone ===
| |
| | |
| params[:bridge][:announcement_tone] = "announcement.wav"
| |
| | |
| Prompt played on the incoming leg with the stream_server before any outgoing call is placed. The outgoing call occurs when the wav file is completed or when the "profile:Busy Tone max duration" is reached.
| |
| | |
| === call_progress_tone ===
| |
| | |
| params[:bridge][:call_progress_tone] = "no_route.wav"
| |
| | |
| Prompt played after "announcement_tone" when reason is not "ok" or when outgoing call disconnect before answer state.
| |
| <br>"none" value is used to bypass "profile:Generate Busy (Congestion) Tone" and to play no audio prompt.
| |
| | |
| === ring_tone ===
| |
| | |
| params[:bridge][:ring_tone] = "ringing.wav"
| |
| | |
| Prompt played between alerting state and answer state. Bypass any other ring back tone (RBT) configured in profile.
| |
| | |
| === max_call_duration ===
| |
| | |
| params[:bridge][:max_call_duration] = "60000"
| |
| | |
| Maximum call duration in millisecond for the current bridge. This timer is started when entering answer state.
| |
| | |
| === call_duration_reason ===
| |
| | |
| params[:bridge][:call_duration_reason] = :resource_unavailable
| |
| | |
| Drop both legs with this reason when call duration (:max_call_duration) is reached.
| |
| | |
| === disconnect_tone ===
| |
| | |
| params[:bridge][:disconnect_tone] = "max_duration.wav"
| |
| | |
| Prompt played (on the incoming leg only) when call duration (:max_call_duration) is reached before terminating the leg with call duration reason (:call_duration_reason).
| |
| | |
| === UUI (user-to-user indication) values ===
| |
| | |
| Byte array represented as ruby String. Use ''call.get(:uui).each_byte'' to access the data in case the UUI contains non printable character.
| |
| | |
| === uui_forward_enabled values ===
| |
| | |
| Controls forwarding or discarding of UUI to outgoing call leg.
| |
| | |
| Values for this parameter are "0", "1", "false" or "true. 0/false: UUI is not forwarded to outgoing call leg 1/true: UUI is forwarded to outgoing call leg The value for this parameter at input of routing script depends on the "Forward UUI" parameter in the "Advanced" section of the Gateway configuration page of the Web Portal. The script may change this value to override the Gateway configuration.
| |
| | |
| == Reason values ==
| |
| | |
| Check here for Termination Reason Cause codes:<br>
| |
| | |
| [http://docs.telcobridges.com/mediawiki/index.php/Termination_cause_codes Termination Reason Cause codes]
| |
| <br>
| |
| | |
| == Nap status ==
| |
| | |
| All the status fields of the NAPs are provided for use by the routing scripts. See the nap status provider for more details on which fields are available in the CEngineStatTransNap.hpp file.
| |
| | |
| '''Notice:''' These values may change between major release.
| |
| | |
| #define NAP_STATS_FIELDS \
| |
| /* Field, szName, szDescription, szOptions */ \
| |
| ( SIGNALING_TYPE, "signaling_type", "Signaling type.", "" ) \
| |
| ( INCOMING_CALL_CNT, "inst_incoming_call_cnt", "Instantaneous Count of incoming calls.", "" ) \
| |
| ( OUTGOING_CALL_CNT, "inst_outgoing_call_cnt", "Instantaneous Count of outgoing calls.", "" ) \
| |
| ( AVAILABLE_CNT, "available_cnt", "Number of available circuits or channels.", "" ) \
| |
| ( UNAVAILABLE_CNT, "unavailable_cnt", "Number of unavailable circuits or channels.", "" ) \
| |
| ( AVAILABILITY_PCT, "availability_percent", "Percentage of available circuits or channels.", "" ) \
| |
| ( USAGE_PCT, "usage_percent", "Percentage of used circuits or channels.", "" ) \
| |
| ( TOTAL_INCOMING_CALL_CNT, "total_incoming_call_cnt", "Total Count of incoming calls.", "" ) \
| |
| ( ASR_STRUCT, "asr_statistics_struct", "Detailed Answer-Seizure Rate Statistics.", "" ) \
| |
| ( GLOBAL_ASR_PCT, "global_asr_percent", "Global calculated ASR percentage.", "" ) \
| |
| ( TOTAL_OUTGOING_CALL_CNT, "total_outgoing_call_cnt", "Total Count of outgoing calls.", "" ) \
| |
| ( LAST_24H_ASR_PCT, "last_24h_asr_percent", "Last 24 hours calculated ASR percentage.", "" ) \
| |
| ( LAST_24H_OUTGOING_CALL_CNT, "last_24h_outgoing_call_cnt", "Last 24 hours outgoing calls.", "" ) \
| |
| ( HOUR_ASR_PCT, "current_hour_asr_percent", "Current hour calculated ASR percentage.", "" ) \
| |
| ( HOUR_OUTGOING_CALL_CNT, "current_hour_outgoing_call_cnt", "Current hour outgoing calls.", "" ) \
| |
| ( LAST_HOUR_ASR_PCT, "last_hour_asr_percent", "Last hour calculated ASR percentage.", "" ) \
| |
| ( LAST_HOUR_OUTGOING_CALL_CNT, "last_hour_outgoing_call_cnt", "Last hour outgoing calls.", "" ) \
| |
| ( AVAILABILITY_DETECTION_STRUCT, "availability_detection_struct", "Detailed availibility detection Statistics", "" ) \
| |
| ( POLL_REMOTE_PROXY, "poll_remote_proxy", "Remote proxy polling enabled", "" ) \
| |
| ( IS_AVAILABLE, "is_available", "Remote proxy actually available or not", "" ) \
| |
| ( TIME_SINCE_POLLING, "time_since_polling", "Time since the last availibility polling", "" ) \
| |
| ( TIME_AVAILABLE_SECONDS, "time_available_seconds", "Number of seconds since the NAP is available", "x" ) \
| |
| ( TIME_UNAVAILABLE_SECONDS, "time_unavailable_seconds", "Number of seconds since the NAP is unavailable", "x" ) \
| |
| ( REGISTRATION_STRUCT, "registration_struct", "Detailed registration Statistics", "" ) \
| |
| ( REGISTER_TO_PROXY, "register_to_proxy", "Register to proxy enabled", "" ) \
| |
| ( IS_REGISTERED, "registered", "Actually registered or not", "" ) \
| |
| ( TIME_SINCE_REFRESH, "time_since_refresh", "Time since the last refresh", "" ) \
| |
| ( TIME_REGISTERED_SECONDS, "time_registered_seconds", "Number of seconds since the NAP is registered", "x" ) \
| |
| ( TIME_NOT_REGISTERED_SECONDS, "time_not_registered_seconds", "Number of seconds since the NAP is not registered", "x" ) \
| |
| /*!< Nap Status Fields */
| |
| | |
| <br> If the nap status is part of a substructure, it's name in the routing scripts must be composed of the structure name appended by an underscore and the field name.
| |
| | |
| For example the name to use for the global [[ASR]] percentage is:
| |
| | |
| asr_statistics_struct_global_asr_percent
| |
| | |
| <br> It is also possible to add dynamic nap attributes in the web portal. These can be referenced by their name.
| |
| | |
| == Test parameters ==
| |
| | |
| === @call_params ===
| |
| | |
| That variable should contain a hash of call parameters that will passed to the routing script. This is equivalent to the incoming call parameters.
| |
| | |
| <br>
| |
| | |
| === @nap_list ===
| |
| | |
| A list of hash containing the nap statuses. This is equivalent to the nap statuses at the time the call is to be routed.
| |
| | |
| '''The nap list is hashed by the nap names in UPPERCASE.''' It is important to consider this when creating new dynamic route or nap attributes that may nap names that will be used to fetch a status.
| |
| | |
| <br>
| |
| | |
| === @params ===
| |
| | |
| A hash of hashes containing parameters. This hash contains bridge parameters and other kind of parameter groups may be added in the future.
| |
| | |
| Example: @params = {:bridge => {:announcement_tone, "announcement.wav"}}
| |
| | |
| <br>
| |
| | |
| ----
| |
| | |
| <br> Back to [[Routing script tutorial|Routing Script Tutorial]].
| |
