PinpointSMSVoiceV2 / Client / send_destination_number_verification_code
send_destination_number_verification_code#
- PinpointSMSVoiceV2.Client.send_destination_number_verification_code(**kwargs)#
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.
See also: AWS API Documentation
Request Syntax
response = client.send_destination_number_verification_code( VerifiedDestinationNumberId='string', VerificationChannel='TEXT'|'VOICE', LanguageCode='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_TW', OriginationIdentity='string', ConfigurationSetName='string', Context={ 'string': 'string' }, DestinationCountryParameters={ 'string': 'string' } )
- Parameters:
VerifiedDestinationNumberId (string) –
[REQUIRED]
The unique identifier for the verified destination phone number.
VerificationChannel (string) –
[REQUIRED]
Choose to send the verification code as an SMS or voice message.
LanguageCode (string) – Choose the language to use for the message.
OriginationIdentity (string) – The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
ConfigurationSetName (string) – The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
Context (dict) –
You can specify custom data in this field. If you do, that data is logged to the event destination.
(string) –
(string) –
DestinationCountryParameters (dict) –
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.
(string) –
(string) –
- Return type:
dict
- Returns:
Response Syntax
{ 'MessageId': 'string' }
Response Structure
(dict) –
MessageId (string) –
The unique identifier for the message.
Exceptions
PinpointSMSVoiceV2.Client.exceptions.ServiceQuotaExceededException
PinpointSMSVoiceV2.Client.exceptions.ThrottlingException
PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException
PinpointSMSVoiceV2.Client.exceptions.ResourceNotFoundException
PinpointSMSVoiceV2.Client.exceptions.ValidationException
PinpointSMSVoiceV2.Client.exceptions.ConflictException
PinpointSMSVoiceV2.Client.exceptions.InternalServerException