local-response-map

local-response-map > entries

Use the entries subelement to add a local response map entry for RFC3326 support. Each entry into the map allows for the configuration of a unique SIP response code and description in the sip-status and sip-reason fields, which will appear in the “Status-line” of the SIP response. The q850-cause and q850-reason fields are part of the optional “Reason Header” which is added to the SIP response if enabled through the sip-config configuration element.

Parameters

local-error

Enter the local error condition. When not specified, the sip-reason field in the SIP response defaults to "Service Unavailable".

Table 4-1 local-error

Value	Description
`invalid-message`	Maps responses for locally rejected invalid SIP messages, including malformed requests or failed trunk group URI validation.
`cpu-overload`	Maps responses when the SBC rejects a request because CPU overload protection is active.
`media-released`	Maps Reason-header behavior for locally generated BYE requests when media or the dialog is released by the SBC.
`media-not-allocated`	Maps responses when media allocation fails and no more specific media error applies.
`enum-void-route`	Maps responses when ENUM or local routing returns no usable route for the request.
`monthly-minutes-exceed`	Maps responses when monthly minutes admission control rejects an INVITE.
`next-hop-sa-oos`	Maps responses when the selected next-hop session agent is out of service, standby, disabled, or otherwise unavailable.
`recv-sa-exc-constraints`	Maps ingress rejections when the previous-hop session agent exceeds configured session constraints.
`recv-sip-int-exc-constraints`	Maps ingress rejections when the receiving SIP interface exceeds configured session constraints.
`next-hop-sa-exc-constraints`	Maps egress rejections when the next-hop session agent exceeds configured session constraints.
`next-hop-sip-int-exc-constraints`	Maps egress rejections when the next-hop SIP interface exceeds configured session constraints.
`realm-bw-exc-poly-serv-reject`	Maps responses when realm bandwidth CAC fails or the external bandwidth policy server rejects the request.
`no-steering-pool-ports-available`	Maps media failures where the media manager cannot allocate a steering-pool port.
`no-media-flow-found`	Maps media failures where the requested media flow cannot be found.
`no-media-interface-found-for-realm`	Maps media failures where no media interface is available for the realm.
`media-recording-failure`	Maps media allocation failures caused by call recording setup problems.
`allow-anonymous-rejection`	Maps responses when anonymous endpoint policy rejects the previous hop or request.
`sdp-address-mismatch`	Maps responses when SDP address correlation rejects a non-HNT request because the SDP address does not match the source address.
`request-method-throttled`	Maps responses when method-based constraints or throttling reject the request.
`reg-cache-full`	Maps REGISTER responses when the registration cache limit is exceeded; the code also adds Retry-After when configured.
`per-user-cac-exc-sessions`	Maps responses when per-user CAC rejects a non-priority call because the user session count limit is exceeded.
`per-user-nsep-exc-rate`	Maps responses when NS/EP or MPS per-user CAC session-rate limits are exceeded.
`recv-conditional-cac-reject`	Maps responses when conditional CAC rejects the request, including conditional bandwidth failure cases.
`ldap-unavailable`	Maps responses when LDAP lookup processing reports the LDAP server unavailable and LDAP failure mapping is enabled.
`allowed-elements-profile-rejection`	Maps responses when allowlist or allowed-elements-profile rules reject the SIP request.
`recording-required`	Maps responses when recording is mandatory but a recording target or recording session cannot be established.
`hss-lir-timeout`	Maps responses when an HSS Cx Location-Info-Request times out during routing.
`hss-lir-failure`	Maps responses when an HSS Cx Location-Info-Request fails for a non-timeout reason.
`transcoding-licensed-session-capacity-reached`	Maps responses when transcoding is needed but the licensed transcoding session capacity is exhausted.
`dsp-resource-limit-reached`	Maps responses when transcoding or media service setup fails because no DSP resources are available.
`licensed-session-capacity-reached`	Maps responses when the SBC licensed session capacity is reached.
`fraud-protection-reject-call`	Maps responses when the Fraud Protection Engine tags the user and instructs the SBC to drop the call.
`rx-rar-loss-of-bearer`	Maps Diameter Rx RAR Specific-Action: indication of loss of bearer; default SIP mapping is 503 if no local entry exists.
`rx-rar-release-of-bearer`	Maps Diameter Rx RAR Specific-Action: indication of release of bearer; default SIP mapping is 503 if no local entry exists.
`rx-rar-out-of-credit`	Maps Diameter Rx RAR Specific-Action: out of credit; default SIP mapping is 503 if no local entry exists.
`rx-rar-failed-resources-allocation`	Maps Diameter Rx RAR Specific-Action: failed resource allocation; default SIP mapping is 503 if no local entry exists.
`rx-rar-access-network-info-reporting_failure`	Maps Diameter Rx RAR Specific-Action: access network information reporting failure; default SIP mapping is 503 if no local entry exists.
`rx-asr-bearer-released`	Maps Diameter Rx ASR Abort-Cause: bearer released; default SIP mapping is 503 if no local entry exists.
`rx-asr-insufficient-server-resources`	Maps Diameter Rx ASR Abort-Cause: insufficient server resources; default SIP mapping is 503 if no local entry exists.
`rx-asr-insufficient-bearer-resources`	Maps Diameter Rx ASR Abort-Cause: insufficient bearer resources; default SIP mapping is 503 if no local entry exists.
`rx-asr-ps-to-cs-handover`	Maps Diameter Rx ASR Abort-Cause: packet-switched to circuit-switched handover; default SIP mapping is 503 if no local entry exists.
`rx-asr-sponsored-data-connectivity-disallowed`	Maps Diameter Rx ASR Abort-Cause: sponsored data connectivity disallowed; default SIP mapping is 503 if no local entry exists.
`bad-request-400`	Maps locally generated SIP 400 Bad Request responses to configured SIP/Q.850 values and Reason-header text.
`unauthorized-401`	Maps locally generated SIP 401 Unauthorized responses to configured SIP/Q.850 values and Reason-header text.
`payment-required-402`	Maps locally generated SIP 402 Payment Required responses to configured SIP/Q.850 values and Reason-header text.
`forbidden-403`	Maps locally generated SIP 403 Forbidden responses to configured SIP/Q.850 values and Reason-header text.
`not-found-404`	Maps locally generated SIP 404 Not Found responses to configured SIP/Q.850 values and Reason-header text.
`method-not-allowed-405`	Maps locally generated SIP 405 Method Not Allowed responses to configured SIP/Q.850 values and Reason-header text.
`not-acceptable-406`	Maps locally generated SIP 406 Not Acceptable responses to configured SIP/Q.850 values and Reason-header text.
`proxy-authentication-required-407`	Maps locally generated SIP 407 Proxy Authentication Required responses to configured SIP/Q.850 values and Reason-header text.
`request-timeout-408`	Maps locally generated SIP 408 Request Timeout responses to configured SIP/Q.850 values and Reason-header text.
`conflict-409`	Maps locally generated SIP 409 Conflict responses to configured SIP/Q.850 values and Reason-header text.
`gone-410`	Maps locally generated SIP 410 Gone responses to configured SIP/Q.850 values and Reason-header text.
`length-required-411`	Maps locally generated SIP 411 Length Required responses to configured SIP/Q.850 values and Reason-header text.
`request-entity-too-large-413`	Maps locally generated SIP 413 Request Entity Too Large responses to configured SIP/Q.850 values and Reason-header text.
`request-uri-too-large-414`	Maps locally generated SIP 414 Request-URI Too Large responses to configured SIP/Q.850 values and Reason-header text.
`unsupported-media-type-415`	Maps locally generated SIP 415 Unsupported Media Type responses to configured SIP/Q.850 values and Reason-header text.
`unsupported-uri-scheme-416`	Maps locally generated SIP 416 Unsupported URI Scheme responses to configured SIP/Q.850 values and Reason-header text.
`unknown-resource-priority-417`	Maps locally generated SIP 417 Unknown Resource-Priority responses to configured SIP/Q.850 values and Reason-header text.
`bad-extension-420`	Maps locally generated SIP 420 Bad Extension responses to configured SIP/Q.850 values and Reason-header text.
`extension-required-421`	Maps locally generated SIP 421 Extension Required responses to configured SIP/Q.850 values and Reason-header text.
`session-interval-too-small-422`	Maps locally generated SIP 422 Session Interval Too Small responses to configured SIP/Q.850 values and Reason-header text.
`interval-too-brief-423`	Maps locally generated SIP 423 Interval Too Brief responses to configured SIP/Q.850 values and Reason-header text.
`temporarily-unavailable-480`	Maps locally generated SIP 480 Temporarily Unavailable responses to configured SIP/Q.850 values and Reason-header text.
`call/transaction-does-not-exist-481`	Maps locally generated SIP 481 Call/Transaction Does Not Exist responses to configured SIP/Q.850 values and Reason-header text.
`loop-detected-482`	Maps locally generated SIP 482 Loop Detected responses to configured SIP/Q.850 values and Reason-header text.
`too-many-hops-483`	Maps locally generated SIP 483 Too Many Hops responses to configured SIP/Q.850 values and Reason-header text.
`address-incomplete-484`	Maps locally generated SIP 484 Address Incomplete responses to configured SIP/Q.850 values and Reason-header text.
`ambiguous-485`	Maps locally generated SIP 485 Ambiguous responses to configured SIP/Q.850 values and Reason-header text.
`busy-here-486`	Maps locally generated SIP 486 Busy Here responses to configured SIP/Q.850 values and Reason-header text.
`request-terminated-487`	Maps locally generated SIP 487 Request Terminated responses to configured SIP/Q.850 values and Reason-header text.
`not-acceptable-here-488`	Maps locally generated SIP 488 Not Acceptable Here responses to configured SIP/Q.850 values and Reason-header text.
`bad-event-489`	Maps locally generated SIP 489 Bad Event responses to configured SIP/Q.850 values and Reason-header text.
`request-pending-491`	Maps locally generated SIP 491 Request Pending responses to configured SIP/Q.850 values and Reason-header text.
`undecipherable-493`	Maps locally generated SIP 493 Undecipherable responses to configured SIP/Q.850 values and Reason-header text.
`security-agreement-required-494`	Maps locally generated SIP 494 Security Agreement Required responses to configured SIP/Q.850 values and Reason-header text.
`internal-server-error-500`	Maps locally generated SIP 500 Internal Server Error responses to configured SIP/Q.850 values and Reason-header text.
`not-implemented-501`	Maps locally generated SIP 501 Not Implemented responses to configured SIP/Q.850 values and Reason-header text.
`bad-gateway-502`	Maps locally generated SIP 502 Bad Gateway responses to configured SIP/Q.850 values and Reason-header text.
`service-unavailable-503`	Maps locally generated SIP 503 Service Unavailable responses to configured SIP/Q.850 values and Reason-header text.
`gateway-timeout-504`	Maps locally generated SIP 504 Gateway Timeout responses to configured SIP/Q.850 values and Reason-header text.
`version-not-supported-505`	Maps locally generated SIP 505 Version Not Supported responses to configured SIP/Q.850 values and Reason-header text.
`message-too-large-513`	Maps locally generated SIP 513 Message Too Large responses to configured SIP/Q.850 values and Reason-header text.
`precondition-failure-580`	Maps locally generated SIP 580 Precondition Failure responses to configured SIP/Q.850 values and Reason-header text.
`busy-everywhere-600`	Maps locally generated SIP 600 Busy Everywhere responses to configured SIP/Q.850 values and Reason-header text.
`decline-603`	Maps locally generated SIP 603 Decline responses to configured SIP/Q.850 values and Reason-header text.
`does-not-exist-anywhere-604`	Maps locally generated SIP 604 Does Not Exist Anywhere responses to configured SIP/Q.850 values and Reason-header text.
`not-acceptable-606`	Maps locally generated SIP 606 Not Acceptable responses to configured SIP/Q.850 values and Reason-header text.
`unwanted-607`	Maps locally generated SIP 607 Unwanted responses to configured SIP/Q.850 values and Reason-header text.
`rejected-608`	Maps locally generated SIP 608 Rejected responses to configured SIP/Q.850 values and Reason-header text.
`sip-locally-generated-bye`	Maps Reason-header behavior for BYE requests originating from the SBC when no more specific media-release mapping is configured.
`sip-locally-generated-cancel`	Maps Reason-header behavior for CANCEL requests originating from the SBC, which have no response status of their own.
`sip-locally-generated-cancel-for-parallel-fork`	Maps Reason-header behavior for CANCEL requests originating from the SBC that clear other legs after a parallel-forked call completes elsewhere.

sip-status

Enter the SIP response code to use for this error.

Default: 0
Values: Min: 100 / Max: 699

q850-cause

Enter the Q.850 cause code.

Default: 0
Values: Min: 0 / Max: 2147483647

sip-reason

Enter the SIP response code description.

q850-reason

Enter the Q850 cause code description.

method

Enter the name of the locally generated SIP failure response message you want to map to a 200 OK. When this parameter is left blank, the SIP registration response mapping feature is turned off.

register-response-expires

Enter the time, in seconds, you want to use for the expires time when mapping the SIP method you identified in the method parameter.

Values: Min: 0 | Max: 999999999

Path

local-response-map-entries is an subelement under the local-response-map configuration element. The full path from the topmost ACLI prompt is: configure terminal , and then session-router , and then local-response-map , and then entries.