AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateSipRule operation. Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipRule, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Chime.AmazonChimeRequest
      Amazon.Chime.Model.CreateSipRuleRequest

Namespace: Amazon.Chime.Model
Assembly: AWSSDK.Chime.dll
Version: 3.x.y.z

Syntax

C#
public class CreateSipRuleRequest : AmazonChimeRequest
         IAmazonWebServiceRequest

The CreateSipRuleRequest type exposes the following members

Constructors

NameDescription
Public Method CreateSipRuleRequest()

Properties

NameTypeDescription
Public Property Disabled System.Boolean

Gets and sets the property Disabled.

Enables or disables a rule. You must disable rules before you can delete them.

Public Property Name System.String

Gets and sets the property Name.

The name of the SIP rule.

Public Property TargetApplications System.Collections.Generic.List<Amazon.Chime.Model.SipRuleTargetApplication>

Gets and sets the property TargetApplications.

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

Public Property TriggerType Amazon.Chime.SipRuleTriggerType

Gets and sets the property TriggerType.

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

Public Property TriggerValue System.String

Gets and sets the property TriggerValue.

If TriggerType is RequestUriHostname, the value can be the outbound host name of an Amazon Chime 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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5