Menu
Amazon Pinpoint
REST API Reference

SMS Channel

A channel defines the types of platforms to which you can deliver messages. To send a text message, you send the message through the SMS channel type. You can use this resource to create or update an SMS channel.

URI

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

HTTP Methods

DELETE

Delete an SMS channel

Header

Name Required Type

accept

false

string

Path

Name Required Type

application-id

true

string

Response

Status Code Schema

200

SMSChannelResponse

GET

Get an SMS channel

Header

Name Required Type

accept

false

string

Path

Name Required Type

application-id

true

string

Response

Status Code Schema

200

SMSChannelResponse

PUT

Update an SMS channel

Body

Name Required Type

SMSChannelRequest

true

SMSChannelRequest

Header

Name Required Type

accept

false

string

Path

Name Required Type

application-id

true

string

Response

Status Code Schema

200

SMSChannelResponse

Errors

Errors

Status Code Schema Error Type

400

MessageBody

BadRequestException

403

MessageBody

ForbiddenException

404

MessageBody

NotFoundException

405

MessageBody

MethodNotAllowedException

429

MessageBody

TooManyRequestsException

500

MessageBody

InternalServerErrorException

Schemas

Request Schemas

Example SMSChannelRequest

{ "Enabled": true, "SenderId": "string" }

Response Schemas

Example SMSChannelResponse

{ "ApplicationId": "string", "IsArchived": true, "Version": 0, "CreationDate": "string", "LastModifiedDate": "string", "LastModifiedBy": "string", "Id": "string", "Enabled": true, "ShortCode": "string", "SenderId": "string", "Platform": "string" }

Example MessageBody

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

Attributes

SMSChannelRequest

Attribute Type Description

Enabled

boolean

If the channel is enabled for sending messages.

SenderId

string

Sender identifier of your messages.

ShortCode

string

ShortCode registered with phone provider.

SMSChannelResponse

Attribute Type Description

ApplicationId

string

The unique ID of the application to which the SMS channel belongs.

CreationDate

string

The date that the settings were last updated in ISO 8601 format.

Enabled

boolean

If the channel is enabled for sending messages.

Id

string

Channel ID. Not used, only for backwards compatibility.

IsArchived

boolean

Is this channel archived

LastModifiedBy

string

Who last updated this entry

LastModifiedDate

string

Last date this was updated

Platform

string

Platform type. Will be "SMS"

SenderId

string

Sender identifier of your messages.

ShortCode

string

The short code registered with the phone provider.

Version

integer

Version of channel

MessageBody

Attribute Type Description

Message

string

The error message returned from the API.

RequestID

string

The unique message body ID.