Skip to content

CreateSipRuleRequest

Source code in docs_src/capo_chime_sdk_voice/types/create_sip_rule_request.py
class CreateSipRuleRequest(TypedDict, closed=True):
    name: "capo_chime_sdk_voice.types.sip_rule_name.SipRuleName"
    """<p>The name of the SIP rule.</p>"""
    trigger_type: "capo_chime_sdk_voice.types.sip_rule_trigger_type.SipRuleTriggerType"
    """<p>The type of trigger assigned to the SIP rule in <code>TriggerValue</code>, currently <code>RequestUriHostname</code> or <code>ToPhoneNumber</code>.</p>"""
    trigger_value: "capo_chime_sdk_voice.types.non_empty_string.NonEmptyString"
    """<p>If <code>TriggerType</code> is <code>RequestUriHostname</code>, the value can be the outbound host name of a Voice Connector. If <code>TriggerType</code> is <code>ToPhoneNumber</code>, the value can be a customer-owned phone number in the E164 format. The <code>SipMediaApplication</code> specified in the <code>SipRule</code> is triggered if the request URI in an incoming SIP request matches the <code>RequestUriHostname</code>, or if the <code>To</code> header in the incoming SIP request matches the <code>ToPhoneNumber</code> value.</p>"""
    disabled: NotRequired["capo_chime_sdk_voice.types.nullable_boolean.NullableBoolean"]
    """<p>Disables or enables a SIP rule. You must disable SIP rules before you can delete them.</p>"""
    target_applications: "capo_chime_sdk_voice.types.sip_rule_target_application_list.SipRuleTargetApplicationList"
    """<p>List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can be used.</p>"""

disabled instance-attribute

disabled: NotRequired[NullableBoolean]

Disables or enables a SIP rule. You must disable SIP rules before you can delete them.

name instance-attribute

The name of the SIP rule.

target_applications instance-attribute

target_applications: SipRuleTargetApplicationList

List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can be used.

trigger_type instance-attribute

trigger_type: SipRuleTriggerType

The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.

trigger_value instance-attribute

trigger_value: NonEmptyString

If TriggerType is RequestUriHostname, the value can be the outbound host name of a Voice Connector. If TriggerType is ToPhoneNumber, the value can be a customer-owned phone number in the E164 format. The SipMediaApplication specified in the SipRule is triggered if the request URI in an incoming SIP request matches the RequestUriHostname, or if the To header in the incoming SIP request matches the ToPhoneNumber value.