OriginationRoute - Amazon Chime SDK

OriginationRoute

Origination routes define call distribution properties for your SIP hosts to receive inbound calls using an Amazon Chime SDK Voice Connector. Limit: Ten origination routes for each Voice Connector.

Note

The parameters listed below are not required, but you must use at least one.

Contents

Host

The FQDN or IP address to contact for origination traffic.

Type: String

Required: No

Port

The designated origination route port. Defaults to 5060.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 65535.

Required: No

Priority

The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

Protocol

The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use TCP protocol by default.

Type: String

Valid Values: TCP | UDP

Required: No

Weight

The weight assigned to an origination route. When hosts have equal priority, calls are distributed between them based on their relative weights.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

See Also

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