CreateSipRule - Amazon Chime SDK


Creates a SIP rule, which can be used to run a SIP media application as a target for a specific trigger type. For more information about SIP rules, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.

Request Syntax

POST /sip-rules HTTP/1.1 Content-type: application/json { "Disabled": boolean, "Name": "string", "TargetApplications": [ { "AwsRegion": "string", "Priority": number, "SipMediaApplicationId": "string" } ], "TriggerType": "string", "TriggerValue": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.


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

Type: Boolean

Required: No


The name of the SIP rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9 _.-]+

Required: Yes


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

Type: Array of SipRuleTargetApplication objects

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Required: No


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

Type: String

Valid Values: ToPhoneNumber | RequestUriHostname

Required: Yes


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.

Type: String

Pattern: .*\S.*

Required: Yes

Response Syntax

HTTP/1.1 201 Content-type: application/json { "SipRule": { "CreatedTimestamp": "string", "Disabled": boolean, "Name": "string", "SipRuleId": "string", "TargetApplications": [ { "AwsRegion": "string", "Priority": number, "SipMediaApplicationId": "string" } ], "TriggerType": "string", "TriggerValue": "string", "UpdatedTimestamp": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.


The SIP rule information, including the rule ID, triggers, and target applications.

Type: SipRule object


For information about the errors that are common to all actions, see Common Errors.


You don't have the permissions needed to run this action.

HTTP Status Code: 403


The input parameters don't match the service's restrictions.

HTTP Status Code: 400


Multiple instances of the same request were made simultaneously.

HTTP Status Code: 409


The client is permanently forbidden from making the request.

HTTP Status Code: 403


The request exceeds the resource limit.

HTTP Status Code: 400


The service encountered an unexpected error.

HTTP Status Code: 500


The service is currently unavailable.

HTTP Status Code: 503


The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429


The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: