RequestPhoneNumber - Amazon Pinpoint SMS and Voice v2 API

RequestPhoneNumber

Request an origination phone number for use in your account. For more information on phone number request see Requesting a number in the Amazon Pinpoint User Guide.

Request Syntax

{ "ClientToken": "string", "DeletionProtectionEnabled": boolean, "IsoCountryCode": "string", "MessageType": "string", "NumberCapabilities": [ "string" ], "NumberType": "string", "OptOutListName": "string", "PoolId": "string", "RegistrationId": "string", "Tags": [ { "Key": "string", "Value": "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.

ClientToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [!-~]+

Required: No

DeletionProtectionEnabled

By default this is set to false. When set to true the phone number can't be deleted.

Type: Boolean

Required: No

IsoCountryCode

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

Type: String

Length Constraints: Fixed length of 2.

Pattern: [A-Z]{2}

Required: Yes

MessageType

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

Type: String

Valid Values: TRANSACTIONAL | PROMOTIONAL

Required: Yes

NumberCapabilities

Indicates if the phone number will be used for text messages, voice messages, or both.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 2 items.

Valid Values: SMS | VOICE

Required: Yes

NumberType

The type of phone number to request.

Type: String

Valid Values: LONG_CODE | TOLL_FREE | TEN_DLC

Required: Yes

OptOutListName

The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [A-Za-z0-9_:/-]+

Required: No

PoolId

The pool to associated with the phone number. You can use the PoolId or PoolArn.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [A-Za-z0-9_:/-]+

Required: No

RegistrationId

Use this field to attach your phone number for an external registration process.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: \S+

Required: No

Tags

An array of tags (key and value pairs) associate with the requested phone number.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Syntax

{ "CreatedTimestamp": number, "DeletionProtectionEnabled": boolean, "IsoCountryCode": "string", "MessageType": "string", "MonthlyLeasingPrice": "string", "NumberCapabilities": [ "string" ], "NumberType": "string", "OptOutListName": "string", "PhoneNumber": "string", "PhoneNumberArn": "string", "PhoneNumberId": "string", "PoolId": "string", "SelfManagedOptOutsEnabled": boolean, "Status": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TwoWayChannelArn": "string", "TwoWayEnabled": boolean }

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.

CreatedTimestamp

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

Type: Timestamp

DeletionProtectionEnabled

By default this is set to false. When set to true the phone number can't be deleted.

Type: Boolean

IsoCountryCode

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

Type: String

Length Constraints: Fixed length of 2.

Pattern: [A-Z]{2}

MessageType

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

Type: String

Valid Values: TRANSACTIONAL | PROMOTIONAL

MonthlyLeasingPrice

The monthly price, in US dollars, to lease the phone number.

Type: String

NumberCapabilities

Indicates if the phone number will be used for text messages, voice messages or both.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 2 items.

Valid Values: SMS | VOICE

NumberType

The type of number that was released.

Type: String

Valid Values: LONG_CODE | TOLL_FREE | TEN_DLC

OptOutListName

The name of the OptOutList that is associated with the requested phone number.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9_-]+

PhoneNumber

The new phone number that was requested.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: \+?[1-9][0-9]{1,18}

PhoneNumberArn

The Amazon Resource Name (ARN) of the requested phone number.

Type: String

PhoneNumberId

The unique identifier of the new phone number.

Type: String

PoolId

The unique identifier of the pool associated with the phone number

Type: String

SelfManagedOptOutsEnabled

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

Type: Boolean

Status

The current status of the request.

Type: String

Valid Values: PENDING | ACTIVE | ASSOCIATING | DISASSOCIATING | DELETED

Tags

An array of key and value pair tags that are associated with the phone number.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

TwoWayChannelArn

The ARN used to identify the two way channel.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:\S+

TwoWayEnabled

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

Type: Boolean

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: