UpdatePhoneNumber - Amazon Pinpoint SMS and Voice v2 API

UpdatePhoneNumber

Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection.

If the origination phone number is associated with a pool, an Error is returned.

Request Syntax

{ "DeletionProtectionEnabled": boolean, "OptOutListName": "string", "PhoneNumberId": "string", "SelfManagedOptOutsEnabled": boolean, "TwoWayChannelArn": "string", "TwoWayEnabled": boolean }

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.

DeletionProtectionEnabled

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

Type: Boolean

Required: No

OptOutListName

The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.

Type: String

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

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

Required: No

PhoneNumberId

The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.

Type: String

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

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

Required: Yes

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

Required: No

TwoWayChannelArn

The Amazon Resource Name (ARN) of the two way channel.

Type: String

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

Pattern: arn:\S+

Required: No

TwoWayEnabled

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

Type: Boolean

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", "SelfManagedOptOutsEnabled": boolean, "Status": "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

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 leasing price of the phone number, in US dollars.

Type: String

NumberCapabilities

Specifies if the number could be used for text messages, voice 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 requested.

Type: String

Valid Values: SHORT_CODE | LONG_CODE | TOLL_FREE | TEN_DLC

OptOutListName

The name of the OptOutList associated with the phone number.

Type: String

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

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

PhoneNumber

The phone number that was updated.

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 updated phone number.

Type: String

PhoneNumberId

The unique identifier of the phone number.

Type: String

SelfManagedOptOutsEnabled

This is true if self managed opt-out are enabled.

Type: Boolean

Status

The current status of the request.

Type: String

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

TwoWayChannelArn

The Amazon Resource Name (ARN) of 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

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: