Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ReleasePhoneNumber

Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages.

If the origination phone number has deletion protection enabled or is associated with a pool, an error is returned.

Request Syntax


{
   "PhoneNumberId": "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.

PhoneNumberId

The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and PhoneNumberArn.

Important

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

Type: String

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

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

Required: Yes

Response Syntax


{
   "CreatedTimestamp": number,
   "IsoCountryCode": "string",
   "MessageType": "string",
   "MonthlyLeasingPrice": "string",
   "NumberCapabilities": [ "string" ],
   "NumberType": "string",
   "OptOutListName": "string",
   "PhoneNumber": "string",
   "PhoneNumberArn": "string",
   "PhoneNumberId": "string",
   "RegistrationId": "string",
   "SelfManagedOptOutsEnabled": boolean,
   "Status": "string",
   "TwoWayChannelArn": "string",
   "TwoWayChannelRole": "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

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 message type that was associated with the phone number.

Type: String

Valid Values: TRANSACTIONAL | PROMOTIONAL

MonthlyLeasingPrice

The monthly 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 3 items.

Valid Values: SMS | VOICE | MMS

NumberType

The type of number that was released.

Type: String

Valid Values: SHORT_CODE | LONG_CODE | TOLL_FREE | TEN_DLC | SIMULATOR

OptOutListName

The name of the OptOutList that was 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 released.

Type: String

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

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

PhoneNumberArn

The PhoneNumberArn of the phone number that was released.

Type: String

PhoneNumberId

The PhoneNumberId of the phone number that was released.

Type: String

RegistrationId

The unique identifier for the registration.

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, AWS End User Messaging SMS and Voice 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

TwoWayChannelArn

The Amazon Resource Name (ARN) of the TwoWayChannel.

Type: String

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

Pattern: \S+

TwoWayChannelRole

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

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