URI HTTP methods Schemas Properties See also

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 enable, 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.

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).
`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: UpdateVoiceChannel

Enables the voice channel for an application or 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).
`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: 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).
`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 Voice 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
}

Response bodies


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

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.

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.
`CreationDate`	string	False	The date and time, in ISO 8601 format, when the voice channel was enabled.
`Enabled`	boolean	False	Specifies whether the voice 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 voice channel. This property is retained only for backward compatibility.
`IsArchived`	boolean	False	Specifies whether the voice channel is archived.
`LastModifiedBy`	string	False	The user who last modified the voice channel.
`LastModifiedDate`	string	False	The date and time, in ISO 8601 format, when the voice channel was last modified.
`Platform`	string	True	The type of messaging or notification platform for the channel. For the voice channel, this value is `VOICE`.
`Version`	integer	False	The current version of the voice channel.