The Amazon Chime SDK Identity, Media Pipelines, Meetings, and Messaging APIs are now published on the new Amazon Chime SDK API Reference. For more information, see the Amazon Chime SDK API Reference.
PhoneNumber
A phone number used for Amazon Chime Business Calling or an Amazon Chime Voice Connector.
Contents
- Associations
-
The phone number associations.
Type: Array of PhoneNumberAssociation objects
Required: No
- CallingName
-
The outbound calling name associated with the phone number.
Type: String
Pattern:
^$|^[a-zA-Z0-9 ]{2,15}$Required: No
- CallingNameStatus
-
The outbound calling name status.
Type: String
Valid Values:
Unassigned | UpdateInProgress | UpdateSucceeded | UpdateFailedRequired: No
- Capabilities
-
The phone number capabilities.
Type: PhoneNumberCapabilities object
Required: No
- Country
-
The phone number country. Format: ISO 3166-1 alpha-2.
Type: String
Pattern:
[A-Z]{2}Required: No
- CreatedTimestamp
-
The phone number creation timestamp, in ISO 8601 format.
Type: Timestamp
Required: No
- DeletionTimestamp
-
The deleted phone number timestamp, in ISO 8601 format.
Type: Timestamp
Required: No
- E164PhoneNumber
-
The phone number, in E.164 format.
Type: String
Pattern:
^\+?[1-9]\d{1,14}$Required: No
- PhoneNumberId
-
The phone number ID.
Type: String
Required: No
- ProductType
-
The phone number product type.
Type: String
Valid Values:
BusinessCalling | VoiceConnector | SipMediaApplicationDialInRequired: No
- Status
-
The phone number status.
Type: String
Valid Values:
AcquireInProgress | AcquireFailed | Unassigned | Assigned | ReleaseInProgress | DeleteInProgress | ReleaseFailed | DeleteFailedRequired: No
- Type
-
The phone number type.
Type: String
Valid Values:
Local | TollFreeRequired: No
- UpdatedTimestamp
-
The updated phone number timestamp, in ISO 8601 format.
Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
