PinpointSMSVoiceV2 / Client / create_verified_destination_number

create_verified_destination_number#

PinpointSMSVoiceV2.Client.create_verified_destination_number(**kwargs)#

You can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination numbers.

See also: AWS API Documentation

Request Syntax

response = client.create_verified_destination_number(
    DestinationPhoneNumber='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientToken='string'
)
Parameters:

  • DestinationPhoneNumber (string) –

    [REQUIRED]

    The verified destination phone number, in E.164 format.

  • Tags (list) –

    An array of tags (key and value pairs) to associate with the destination number.

    • (dict) –

      The list of tags to be added to the specified topic.

      • Key (string) – [REQUIRED]

        The key identifier, or name, of the tag.

      • Value (string) – [REQUIRED]

        The string value associated with the key of the tag.

  • ClientToken (string) –

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, a randomly generated token is used for the request to ensure idempotency.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'VerifiedDestinationNumberArn': 'string',
    'VerifiedDestinationNumberId': 'string',
    'DestinationPhoneNumber': 'string',
    'Status': 'PENDING'|'VERIFIED',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    '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 verified destination phone number, in E.164 format.

    • Status (string) –

      The status of the verified destination phone number.

      • PENDING: The phone number hasn’t been verified yet.

      • VERIFIED: The phone number is verified and can receive messages.

    • Tags (list) –

      An array of tags (key and value pairs) to associate with the destination number.

      • (dict) –

        The list of tags to be added to the specified topic.

        • Key (string) –

          The key identifier, or name, of the tag.

        • Value (string) –

          The string value associated with the key of the tag.

    • CreatedTimestamp (datetime) –

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

Exceptions