Amazon Pinpoint
REST API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

SMS Channel

A channel is a type of platform that you can deliver messages to. To send an SMS text message, you send the message through the SMS channel. Before you can use Amazon Pinpoint to send text messages, you must enable the SMS channel for an Amazon Pinpoint application.

The SMS Channel resource represents the status, sender ID, and other settings of the SMS channel for a specific application. You can use this resource to enable, retrieve information about, update, or disable (delete) the SMS channel for an application.

URI

/v1/apps/application-id/channels/sms

HTTP Methods

GET

Operation ID: GetSmsChannel

Retrieves information about the status and settings of the SMS channel for an application.

Path Parameters

Name Type Required Description
application-id String True

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Header Parameters

Name Type Required Description
accept String False

Indicates which content types, expressed as MIME types, the client understands.

Responses

Status Code Response Model Description
200 SMSChannelResponse

The request succeeded.

400 MessageBody

The request contains a syntax error (BadRequestException).

403 MessageBody

The request was denied because access to the specified resource is forbidden (ForbiddenException).

404 MessageBody

The request failed because the specified resource was not found (NotFoundException).

405 MessageBody

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

429 MessageBody

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

500 MessageBody

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

PUT

Operation ID: UpdateSmsChannel

Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.

Path Parameters

Name Type Required Description
application-id String True

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Header Parameters

Name Type Required Description
accept String False

Indicates which content types, expressed as MIME types, the client understands.

Responses

Status Code Response Model Description
200 SMSChannelResponse

The request succeeded.

400 MessageBody

The request contains a syntax error (BadRequestException).

403 MessageBody

The request was denied because access to the specified resource is forbidden (ForbiddenException).

404 MessageBody

The request failed because the specified resource was not found (NotFoundException).

405 MessageBody

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

429 MessageBody

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

500 MessageBody

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

DELETE

Operation ID: DeleteSmsChannel

Disables the SMS channel for an application and deletes any existing settings for the channel.

Path Parameters

Name Type Required Description
application-id String True

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Header Parameters

Name Type Required Description
accept String False

Indicates which content types, expressed as MIME types, the client understands.

Responses

Status Code Response Model Description
200 SMSChannelResponse

The request succeeded.

400 MessageBody

The request contains a syntax error (BadRequestException).

403 MessageBody

The request was denied because access to the specified resource is forbidden (ForbiddenException).

404 MessageBody

The request failed because the specified resource was not found (NotFoundException).

405 MessageBody

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

429 MessageBody

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

500 MessageBody

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

OPTIONS

Retrieves information about the communication requirements and options that are available for the SMS Channel resource.

Responses

Status Code Response Model Description
200 None

The request succeeded.

Schemas

Request Bodies

Example PUT

{ "Enabled": boolean, "ShortCode": "string", "SenderId": "string" }

Response Bodies

Example SMSChannelResponse

{ "ApplicationId": "string", "IsArchived": boolean, "Version": integer, "CreationDate": "string", "LastModifiedDate": "string", "LastModifiedBy": "string", "Id": "string", "Enabled": boolean, "ShortCode": "string", "SenderId": "string", "Platform": "string", "PromotionalMessagesPerSecond": integer, "TransactionalMessagesPerSecond": integer, "HasCredential": boolean }

Example MessageBody

{ "RequestID": "string", "Message": "string" }

Properties

MessageBody

Provides information about an API request or response.

Property Type Required Description
RequestID

string

False

The unique identifier for the request or response.

Message

string

False

The message that's returned from the API.

SMSChannelRequest

Specifies the status and settings of the SMS channel for an application.

Property Type Required Description
Enabled

boolean

False

Specifies whether to enable the SMS channel for the application.

ShortCode

string

False

The registered short code that you want to use when you send messages through the SMS channel.

SenderId

string

False

The identity that you want to display on recipients' devices when they receive messages from the SMS channel.

SMSChannelResponse

Provides information about the status and settings of the SMS channel for an application.

Property Type Required Description
ApplicationId

string

False

The unique identifier for the application that the SMS channel applies to.

IsArchived

boolean

False

Specifies whether the SMS channel is archived.

Version

integer

False

The current version of the SMS channel.

CreationDate

string

False

The date and time, in ISO 8601 format, when the SMS channel was enabled.

LastModifiedDate

string

False

The date and time, in ISO 8601 format, when the SMS channel was last modified.

LastModifiedBy

string

False

The user who last modified the SMS channel.

Id

string

False

(Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.

Enabled

boolean

False

Specifies whether the SMS channel is enabled for the application.

ShortCode

string

False

The registered short code to use when you send messages through the SMS channel.

SenderId

string

False

The identity that displays on recipients' devices when they receive messages from the SMS channel.

Platform

string

True

The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.

PromotionalMessagesPerSecond

integer

False

The maximum number of promotional messages that you can send through the SMS channel each second.

TransactionalMessagesPerSecond

integer

False

The maximum number of transactional messages that you can send through the SMS channel each second.

HasCredential

boolean

False

(Not used) This property is retained only for backward compatibility.

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

GetSmsChannel

UpdateSmsChannel

DeleteSmsChannel