Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateSipRule

Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.

Important

This API 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.

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.

Disabled

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

Type: Boolean

Required: No

Name

The name of the SIP rule.

Type: String

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

Required: Yes

TargetApplications

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: Yes

TriggerType

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

Type: String

Valid Values: ToPhoneNumber | RequestUriHostname

Required: Yes

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.

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.

SipRule

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

Type: SipRule object

Errors

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

AccessDeniedException

You don't have permissions to perform the requested operation.

HTTP Status Code: 403

BadRequestException

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

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401