SendDestinationNumberVerificationCode
Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number. Creates a new text message with a verification code and send it to a verified destination phone number. Once you have the verification code use VerifyDestinationNumber to opt-in the verified destination phone number to receive messages.
Request Syntax
{
"ConfigurationSetName": "string",
"Context": {
"string" : "string"
},
"DestinationCountryParameters": {
"string" : "string"
},
"LanguageCode": "string",
"OriginationIdentity": "string",
"VerificationChannel": "string",
"VerifiedDestinationNumberId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ConfigurationSetName
-
The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[A-Za-z0-9_:/-]+Required: No
- Context
-
You can specify custom data in this field. If you do, that data is logged to the event destination.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 5 items.
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Key Pattern:
\S+Value Length Constraints: Minimum length of 1. Maximum length of 800.
Value Pattern:
(?!\s)^[\s\S]+(?<!\s)Required: No
- DestinationCountryParameters
-
This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 10 items.
Valid Keys:
IN_TEMPLATE_ID | IN_ENTITY_IDValue Length Constraints: Minimum length of 1. Maximum length of 64.
Value Pattern:
\S+Required: No
- LanguageCode
-
Choose the language to use for the message.
Type: String
Valid Values:
DE_DE | EN_GB | EN_US | ES_419 | ES_ES | FR_CA | FR_FR | IT_IT | JA_JP | KO_KR | PT_BR | ZH_CN | ZH_TWRequired: No
- OriginationIdentity
-
The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
Important
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[A-Za-z0-9_:/\+-]+Required: No
- VerificationChannel
-
Choose to send the verification code as an SMS or voice message.
Type: String
Valid Values:
TEXT | VOICERequired: Yes
- VerifiedDestinationNumberId
-
The unique identifier for the verified destination phone number.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[A-Za-z0-9_:/-]+Required: Yes
Response Syntax
{
"MessageId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- MessageId
-
The unique identifier for the message.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request was denied because you don't have sufficient permissions to access the resource.
HTTP Status Code: 400
- ConflictException
-
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
HTTP Status Code: 400
- InternalServerException
-
The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
HTTP Status Code: 500
- ResourceNotFoundException
-
A requested resource couldn't be found.
HTTP Status Code: 400
- ServiceQuotaExceededException
-
The request would cause a service quota to be exceeded.
HTTP Status Code: 400
- ThrottlingException
-
An error that occurred because too many requests were sent during a certain amount of time.
HTTP Status Code: 400
- ValidationException
-
A validation exception for a field.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
