Reference
Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
Contents
- Type
-
The type of the reference.
DATE
must be of type Epoch timestamp.Type: String
Valid Values:
URL | ATTACHMENT | CONTACT_ANALYSIS | NUMBER | STRING | DATE | EMAIL | EMAIL_MESSAGE
Required: Yes
- Arn
-
The Amazon Resource Name (ARN) of the reference
Type: String
Length Constraints: Minimum length of 20. Maximum length of 256.
Pattern:
^[-:/A-Za-z0-9]+
Required: No
- Status
-
Status of the attachment reference type.
Type: String
Valid Values:
AVAILABLE | DELETED | APPROVED | REJECTED | PROCESSING | FAILED
Required: No
- StatusReason
-
Relevant details why the reference was not successfully created.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 100.
Required: No
- Value
-
A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
Type: String
Length Constraints: Minimum length of 0. Maximum length of 4096.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: