Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListNotifyCountries

Lists countries that support notify messaging. You can optionally filter by channel, use case, or tier.

Request Syntax


{
   "Channels": [ "string" ],
   "MaxResults": number,
   "NextToken": "string",
   "Tier": "string",
   "UseCases": [ "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.

Channels

An array of channels to filter the results by.

Type: Array of strings

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

Valid Values: SMS | VOICE | MMS | RCS

Required: No

MaxResults

The maximum number of results to return per each request.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

Type: String

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

Pattern: .+

Required: No

Tier

The tier to filter the results by.

Type: String

Valid Values: BASIC | ADVANCED

Required: No

UseCases

An array of use cases to filter the results by.

Type: Array of strings

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

Valid Values: CODE_VERIFICATION

Required: No

Response Syntax


{
   "NextToken": "string",
   "NotifyCountries": [ 
      { 
         "CountryName": "string",
         "CustomerOwnedIdentityRequired": boolean,
         "IsoCountryCode": "string",
         "SupportedChannels": [ "string" ],
         "SupportedTiers": [ "string" ],
         "SupportedUseCases": [ "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.

NextToken

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Type: String

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

Pattern: .+

NotifyCountries

An array of NotifyCountryInformation objects that contain the results.

Type: Array of NotifyCountryInformation objects

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

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

The request was denied because you don't have sufficient permissions to access the resource.

Reason: The reason for the exception.

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.

RequestId: The unique identifier of the request.

HTTP Status Code: 500

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.

Fields: The field that failed validation.
Reason: The reason for the exception.

HTTP Status Code: 400