Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

RequestSenderId

Request a new sender ID that doesn't require registration.

Request Syntax


{
   "ClientToken": "string",
   "DeletionProtectionEnabled": boolean,
   "IsoCountryCode": "string",
   "MessageTypes": [ "string" ],
   "SenderId": "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 sender ID 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

MessageTypes

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: Array of strings

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

Valid Values: TRANSACTIONAL | PROMOTIONAL

Required: No

SenderId

The sender ID string to request.

Type: String

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

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

Required: Yes

Tags

An array of tags (key and value pairs) to associate with the sender ID.

Type: Array of Tag objects

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

Required: No

Response Syntax


{
   "DeletionProtectionEnabled": boolean,
   "IsoCountryCode": "string",
   "MessageTypes": [ "string" ],
   "MonthlyLeasingPrice": "string",
   "Registered": boolean,
   "SenderId": "string",
   "SenderIdArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

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.

DeletionProtectionEnabled

By default this is set to false. When set to true the sender ID 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}

MessageTypes

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: Array of strings

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

Valid Values: TRANSACTIONAL | PROMOTIONAL

MonthlyLeasingPrice

The monthly price, in US dollars, to lease the sender ID.

Type: String

Registered

True if the sender ID is registered.

Type: Boolean

SenderId

The sender ID that was requested.

Type: String

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

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

SenderIdArn

The Amazon Resource Name (ARN) associated with the SenderId.

Type: String

Tags

An array of tags (key and value pairs) to associate with the sender ID.

Type: Array of Tag objects

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

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

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