Amazon Pinpoint
REST API Reference

Voice Channel

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

The Voice Channel resource represents the status and other information about the voice channel for a specific application. You can use this resource to retrieve information about, update, or disable (delete) the voice channel for an application.

URI

/v1/apps/application-id/channels/voice

HTTP Methods

GET

Operation ID: GetVoiceChannel

Retrieves information about the status and settings of the voice 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.

x-amz-user-agent String False

Identifies the client that's sending the request.

Responses

Status Code Response Model Description
200 VoiceChannelResponse

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: UpdateVoiceChannel

Updates the status and settings of the voice 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 VoiceChannelResponse

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: DeleteVoiceChannel

Disables the voice 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 VoiceChannelResponse

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 Voice Channel resource.

Responses

Status Code Response Model Description
200 None

The request succeeded.

Schemas

Request Bodies

Example PUT

{ "Enabled": boolean, "OriginationNumber": "string" }

Response Bodies

Example VoiceChannelResponse

{ "ApplicationId": "string", "IsArchived": boolean, "Version": integer, "CreationDate": "string", "LastModifiedDate": "string", "LastModifiedBy": "string", "Id": "string", "Enabled": boolean, "Platform": "string", "VoiceMessagesPerSecond": integer, "OriginationNumber": "string", "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.

VoiceChannelRequest

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

Property Type Required Description
Enabled

boolean

False

Specifies whether to enable the voice channel for the application.

OriginationNumber

string

False

The registered long code that you want to use when you send messages through the voice channel. A long code is a standard phone number from a pool or messaging service. Although it isn't required, we recommend that you specify the phone number in E.164 format to ensure prompt and accurate delivery.

VoiceChannelResponse

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

Property Type Required Description
ApplicationId

string

False

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

IsArchived

boolean

False

Specifies whether the voice channel is archived.

Version

integer

False

The current version of the voice channel.

CreationDate

string

False

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

LastModifiedDate

string

False

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

LastModifiedBy

string

False

The user who last modified the voice channel.

Id

string

False

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

Enabled

boolean

False

Specifies whether the voice channel is enabled for the application.

Platform

string

True

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

VoiceMessagesPerSecond

integer

False

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

OriginationNumber

string

False

The registered long code that's used when you send messages through the voice channel.

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:

GetVoiceChannel

UpdateVoiceChannel

DeleteVoiceChannel