Send TTS Command

Last Updated on : 2023-06-20 14:54:01

Send a text to speech (TTS) command to a device. Then, the device plays the audio based on the input text.

API address

POST: /v1.0/aispeech/voice/push

Description of body

Parameter name	Type	Required	Description
tts	String	false	The text.
audio_url	String	false	The URL of a specified audio file.
tts_url	String	false	The URL of a specified TTS file. `tts_url`, `tts_url_method`, and `tts_url_param` work together to get the audio content.
tts_url_method	String	false	The request method of a specified TTS file.
tts_url_param	String	false	The TTS request parameter, which can be customized as needed.
deviceId	String	false	The device ID.

Parameter name	Type	Description
result	VoicePushResp	The returned result.

Description of result

Parameter name	Type	Description
error_code	String	The error code.
is_success	Boolean	Indicates whether the operation of sending a TTS command is successful.
error_msg	String	The error message.

POST: /v1.0/aispeech/voice/push

{
  "tts": "TTS test",
  "deviceId": "6c5f0f0b5****vabt"
}

{
    "tid": "bc5c849aa36b11ecbe82ba2dd9681f11",
    "result": {
        "isSuccess": true
    },
    "t": 1647244366294,
    "success": true
}

For more information, see error code.