POST
/v1/sms-voice/voice/message
http://sms-voice.pinpoint.{region}.amazonaws.com/v1/sms-voice/voice/messageCreate a new voice message and send it to a recipient's phone number.
Access Token Required: API Key
Body Params
Contentobject
An object that contains a voice message and information about the recipient that you want to send it to.
CallerIdstring
The phone number that appears on recipients' devices when they receive the message.
ConfigurationSetNamestring
The name of the configuration set that you want to use to send the message.
DestinationPhoneNumberstring
The phone number that you want to send the voice message to.
OriginationPhoneNumberstring
The phone number that Amazon Pinpoint should use to send the voice message. This isn't necessarily the phone number that appears on recipients' devices when they receive the message, because you can specify a CallerId parameter in the request.
Responses
{
"success": true,
"data": {
"id": "abc123",
"created_at": "2025-01-01T00:00:00Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters"
}
}Language
CredentialsAPI KEY
API Key
Enter token below to save for later
cURL Request
1curl --request POST \2 --url 'http://sms-voice.pinpoint.{region}.amazonaws.com/v1/sms-voice/voice/message' \3 --header 'accept: application/json' \4 --header 'content-type: application/json'Response
1{2 "success": true,3 "data": {4 "id": "abc123",5 "created_at": "2025-01-01T00:00:00Z"6 }7}