PinpointSMSVoiceV2 / Client / verify_destination_number

verify_destination_number

PinpointSMSVoiceV2.Client.verify_destination_number(**kwargs)

Use the verification code that was received by the verified destination phone number to opt-in the verified destination phone number to receive more messages.

See also: AWS API Documentation

Request Syntax

response = client.verify_destination_number(
    VerifiedDestinationNumberId='string',
    VerificationCode='string'
)

Parameters:

• VerifiedDestinationNumberId (string) –

  [REQUIRED]

  The unique identifier for the verififed destination phone number.

• VerificationCode (string) –

  [REQUIRED]

  The verification code that was received by the verified destination phone number.

Return type:

dict

Returns:

Response Syntax

{
    'VerifiedDestinationNumberArn': 'string',
    'VerifiedDestinationNumberId': 'string',
    'DestinationPhoneNumber': 'string',
    'Status': 'PENDING'|'VERIFIED',
    'CreatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • VerifiedDestinationNumberArn (string) –

    The Amazon Resource Name (ARN) for the verified destination phone number.

  • VerifiedDestinationNumberId (string) –

    The unique identifier for the verified destination phone number.

  • DestinationPhoneNumber (string) –

    The phone number in E.164 format.

  • Status (string) –

    The status for being able to send messages to the phone number.

  • CreatedTimestamp (datetime) –

    The time when the destination phone number was created, in UNIX epoch time format.

Exceptions

• PinpointSMSVoiceV2.Client.exceptions.ThrottlingException

• PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException

• PinpointSMSVoiceV2.Client.exceptions.ResourceNotFoundException

• PinpointSMSVoiceV2.Client.exceptions.ValidationException

• PinpointSMSVoiceV2.Client.exceptions.ConflictException

• PinpointSMSVoiceV2.Client.exceptions.InternalServerException