OriginationIdentityMetadata - Amazon Pinpoint SMS and Voice v2 API

OriginationIdentityMetadata

The metadata for an origination identity associated with a pool.

Contents

IsoCountryCode

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

Type: String

Length Constraints: Fixed length of 2.

Pattern: [A-Z]{2}

Required: Yes

NumberCapabilities

Describes if the origination identity can be used for text messages, voice calls or both.

Type: Array of strings

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

Valid Values: SMS | VOICE

Required: Yes

OriginationIdentity

The unique identifier of the origination identity.

Type: String

Required: Yes

OriginationIdentityArn

The Amazon Resource Name (ARN) associated with the origination identity.

Type: String

Required: Yes

PhoneNumber

The phone number in E.164 format.

Type: String

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

Pattern: \+?[1-9][0-9]{1,18}

Required: No

See Also

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