Actions

Termination cause codes: Difference between revisions

(Added a link to a excel files with Reason Cause list)
(Added category FAQ)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Starting from release 2.5.55 these cause codes can be modified with the Web portal in
<pre>Profiles -&gt; Edit -&gt; Reason Cause Mapping </pre>
[[Image:Reason cause list 1.png|Test]]


<br>
==General Configuration==
 
 
When configuring [[Termination_cause_codes|termination cause codes]], use the following table as a guide. The ''Drop'' column represents codes to use when redirection contents should be dropped and the call should be terminated with the specified code. The ''Forward'' column represents codes to use when redirection contents should be forwarded to the incoming leg with the specified code. If the redirection requests must be processed, the codes are not used.
{| class="wikitable"
|-
! rowspan="2" | Code !! colspan="2" | Drop !! colspan="2" | Forward
|-
! SS7 !! SIP !! SS7 !! SIP
|-
| 14 || 21 || 603 || 14 || 300
|-
| 22 || 21 || 410 || 22 || 301
|-
| 23 || 21 || 410 || 23 || 302
|-
| 300 || 21 || 603 || 23 || 300
|-
| 301 || 21 || 410 || 22 || 301
|-
| 302 || 21 || 410 || 23 || 302
|-
| 305 || 21 || 603 || 23 || 305
|-
| 380 || 21 || 603 || 23 || 380
|}
For each redirection cause code, choose '''Process''' to let the routing scripts process the redirection. Choose '''Stop''' to drop calls when receiving a redirection and use the above table to specify if the redirection contents should be dropped.
 
 
'''To Modify a reason cause code:'''
 
 
1- Click '''Profiles''' in the navigation panel.
 
[[Image:Configure_ReasonCause_0.png]]
 
 
2- Select a profile:
 
[[Image:Configure_ReasonCause_1.png]]
 
 
3- Click '''Edit Reason Cause Mapping''':
 
[[Image:Configure_ReasonCause_2.png]]
 
 
4- Select the reason cause that you wish to create:
 
[[Image:Configure_ReasonCause_3.png]]
 
 
5- Configure the reason cause values
*Click '''Create'''


'''Complete list of Reason Cause mapping between the protocols:'''
[[Image:Configure_ReasonCause_4.png]]


[[File:Reason_Cause.xlsx]]
<br>


== Complete list of Reason Cause mapping between the protocols: ==


Specific internal Toolpack errors:
[[Media:Reason_Cause.xlsx|Reason Cause list in csv]]
    TBCMC_CALL_REASON_CODE_TOOLPACK_NORMAL                    = 200,
<br />
    TBCMC_CALL_REASON_CODE_TOOLPACK_RESOURCE_ERROR            = 201,
    TBCMC_CALL_REASON_CODE_TOOLPACK_TIMEOUT                    = 202,
    TBCMC_CALL_REASON_CODE_TOOLPACK_NO_ROUTE                  = 203,  /* Failed to find route to bridge with */
    TBCMC_CALL_REASON_CODE_TOOLPACK_CALL_COLLISION            = 204,  /* Failed because a call collision occured */
    TBCMC_CALL_REASON_CODE_TOOLPACK_SYNC_DROP                  = 205,  /* Re-sync, but call was incomplete and had to be dropped */
    TBCMC_CALL_REASON_CODE_TOOLPACK_SIGNALING_ERROR            = 206,  /* Error reported by signaling protocol */
    TBCMC_CALL_REASON_CODE_TOOLPACK_LOCALLY_REJECTED          = 207,  /* Rejected by Toolpack Engine application */
    TBCMC_CALL_REASON_CODE_TOOLPACK_INTERFACE_NOT_AVAILABLE    = 208,  /* Failed because the signaling interface is unavailable */
    TBCMC_CALL_REASON_CODE_TOOLPACK_RESET_IN_PROGRESS          = 209,
    TBCMC_CALL_REASON_CODE_TOOLPACK_ADAPTER_REJECT            = 210,
    TBCMC_CALL_REASON_CODE_TOOLPACK_MISSING_INVALID_IE        = 211,
    TBCMC_CALL_REASON_CODE_TOOLPACK_INCOMING_ONLY              = 212,
    TBCMC_CALL_REASON_CODE_TOOLPACK_SYSTEM_CONFIGURATION_CHANGED = 213,
    TBCMC_CALL_REASON_CODE_TOOLPACK_RESOURCE_NO_MORE_AVAILABLE  = 214, /* Resource is down (adapter no more ready) */
    TBCMC_CALL_REASON_CODE_TOOLPACK_INCOMPATIBLE_MEDIA        = 215,  /* Failed because of media incompatibility */
    TBCMC_CALL_REASON_CODE_TOOLPACK_RES_ALLOC_FAILED          = 216,  /* Failed to allocate data path resources for the call */
    TBCMC_CALL_REASON_CODE_TOOLPACK_DATA_PATH_NOT_AVAILABLE    = 217,  /* Data path failure (could be because of unreacheable TDM path or some HW failure) */
    TBCMC_CALL_REASON_CODE_TOOLPACK_LOCAL_CONGESTION          = 218,  /* Congestion in the Toolpack system */
    TBCMC_CALL_REASON_CODE_TOOLPACK_AUTHORIZATION_REQUIRED    = 219,  /* Authorization required on call - this is used internally and should never reach signaling */
    TBCMC_CALL_REASON_CODE_TOOLPACK_DIVERT_NOT_ALLOWED        = 220,  /* Call divert is not allowed */


== Case for the 603 DECLINE and 200 TOOLPACK NORMAL  ==
=== Case for the 603 DECLINE and 200 TOOLPACK NORMAL  ===


The TOOLPACK_NORMAL reason code is mapped to the 603_DECLINE reason code. The reason is the following:  
The TOOLPACK_NORMAL reason code is mapped to the 603_DECLINE reason code. The reason for this is the following:  


A SIP BYE does not include a cause code, so on normal call terminations, So TMedia will send a BYE on SIP, and internally, a 200 TOOLPACK_NORMAL (in the logs and the CDRs). But when the call terminates unexpectedly, for example after a ACM, but before a ANM, Tmedia will still send a BYE on SIP, but internally, it will log a 603 Decline (REASON_CODE_603_DECLINE).  
A SIP BYE does not include a cause code, so on a normal call terminations, TMedia will send a BYE on SIP, and internally, a 200 TOOLPACK_NORMAL (in the logs and the CDRs). When the call terminates unexpectedly, for example after a ACM, but before a ANM, Tmedia will still send a BYE on SIP, but internally, it will log a 603 Decline (REASON_CODE_603_DECLINE).


[[Category:Needs_revising]]
[[category:FAQ]]

Latest revision as of 10:34, 11 January 2023

General Configuration

When configuring termination cause codes, use the following table as a guide. The Drop column represents codes to use when redirection contents should be dropped and the call should be terminated with the specified code. The Forward column represents codes to use when redirection contents should be forwarded to the incoming leg with the specified code. If the redirection requests must be processed, the codes are not used.

Code Drop Forward
SS7 SIP SS7 SIP
14 21 603 14 300
22 21 410 22 301
23 21 410 23 302
300 21 603 23 300
301 21 410 22 301
302 21 410 23 302
305 21 603 23 305
380 21 603 23 380

For each redirection cause code, choose Process to let the routing scripts process the redirection. Choose Stop to drop calls when receiving a redirection and use the above table to specify if the redirection contents should be dropped.


To Modify a reason cause code:


1- Click Profiles in the navigation panel.


2- Select a profile:


3- Click Edit Reason Cause Mapping:


4- Select the reason cause that you wish to create:


5- Configure the reason cause values

  • Click Create


Complete list of Reason Cause mapping between the protocols:

Reason Cause list in csv

Case for the 603 DECLINE and 200 TOOLPACK NORMAL

The TOOLPACK_NORMAL reason code is mapped to the 603_DECLINE reason code. The reason for this is the following:

A SIP BYE does not include a cause code, so on a normal call terminations, TMedia will send a BYE on SIP, and internally, a 200 TOOLPACK_NORMAL (in the logs and the CDRs). When the call terminates unexpectedly, for example after a ACM, but before a ANM, Tmedia will still send a BYE on SIP, but internally, it will log a 603 Decline (REASON_CODE_603_DECLINE).