URI HTTP methods Schemas Properties See also

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).
`413`	`MessageBody`	The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
`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).
`413`	`MessageBody`	The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
`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).
`413`	`MessageBody`	The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
`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.

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.

Responses
Status code	Response model	Description
`200`	None	The request succeeded.

Schemas

Request bodies


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

Response bodies


{
  "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
}


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

Properties

MessageBody

Provides information about an API request or response.

Property	Type	Required	Description
`Message`	string	False	The message that's returned from the API.
`RequestID`	string	False	The unique identifier for the request or response.

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.
`SenderId`	string	False	The alphabetic Sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. To specify a phone number as the sender, omit this parameter and use `OriginationNumber` instead. For more information about support for Sender ID by country, see the Amazon Pinpoint User Guide.
`ShortCode`	string	False	The registered short code that you want to use when you send messages through 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.
`CreationDate`	string	False	The date and time, in ISO 8601 format, when the SMS channel was enabled.
`Enabled`	boolean	False	Specifies whether the SMS channel is enabled for the application.
`HasCredential`	boolean	False	(Not used) This property is retained only for backward compatibility.
`Id`	string	False	(Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.
`IsArchived`	boolean	False	Specifies whether the SMS channel is archived.
`LastModifiedBy`	string	False	The user who last modified the SMS channel.
`LastModifiedDate`	string	False	The date and time, in ISO 8601 format, when the SMS channel was last modified.
`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.
`SenderId`	string	False	The SMS Sender ID that was used to send the message.
`ShortCode`	string	False	The registered short code to use when you send messages through the SMS channel.
`TransactionalMessagesPerSecond`	integer	False	The maximum number of transactional messages that you can send through the SMS channel each second.
`Version`	integer	False	The current version of the SMS channel.