Query the details of the voice template

Last Updated on : 2023-09-11 09:55:07download

Query the details of the voice template.

API address

GET: /v1.0/iot-03/msg-templates/voices/{template_id}

Request parameter

Parameter name Type IN Required Description
template_id String uri true Template ID.

Return parameter

Parameter name Type Description
result VoiceTemplateDetailRes

Description of result

Parameter name Type Description
name String The template name with 1 to 30 characters.
content String The template content with 1 to 200 characters.
type Integer The voice type. 0: verification code, 1: voice notification.
status Integer The review status of the template. 0: The review is in progress. 1: Passed the review. 2: Failed to pass the review. View the reasons for failure in verify_reason.
verify_code Integer The review code. For more information, see the list of review codes.
verify_reason String Describe the reason why the review is not passed.

Request example

GET: /v1.0/iot-03/msg-templates/voices/VOICE_12313****

Return example

{ "result": { "verify_code": 100, "type": 0, "content": "You are registering an account. The verification code is: ${code}, valid for 5 minutes.", "verify_reason": "Illegal words", "name": "The template of the voice verification code", "status": 2 }, "t": 1586153261345, "success": true }

Error code

For more information, see error code.