forked from docs/doc-exports
Zaoxu, Li
152a7d9381
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com> Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com> Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>
147 lines
11 KiB
HTML
147 lines
11 KiB
HTML
<a name="smn_api_53005"></a><a name="smn_api_53005"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Details of a Message Template</h1>
|
|
<div id="body61041458"><div class="section" id="smn_api_53005__section17649112"><h4 class="sectiontitle">Description</h4><ul id="smn_api_53005__ul33304380203733"><li id="smn_api_53005__li51147505203733">API name<p id="smn_api_53005__p38624841203741"><a name="smn_api_53005__li51147505203733"></a><a name="li51147505203733"></a>QueryMessageTemplateDetail</p>
|
|
</li></ul>
|
|
<ul id="smn_api_53005__ul20998054203745"><li id="smn_api_53005__li46884910203750">Function<p id="smn_api_53005__p45411103"><a name="smn_api_53005__li46884910203750"></a><a name="li46884910203750"></a>Query the template details, including the template content.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="smn_api_53005__section24624288"><h4 class="sectiontitle">URI</h4><ul id="smn_api_53005__ul54420716"><li id="smn_api_53005__li20024398">URI format<p id="smn_api_53005__p46001857"><a name="smn_api_53005__li20024398"></a><a name="li20024398"></a>GET /v2/{project_id}/notifications/message_template/{message_template_id}</p>
|
|
</li></ul>
|
|
<ul id="smn_api_53005__ul11363535"><li id="smn_api_53005__li35162951">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="smn_api_53005__table48031108" frame="border" border="1" rules="all"><thead align="left"><tr id="smn_api_53005__row27859461"><th align="left" class="cellrowborder" valign="top" width="25.040000000000003%" id="mcps1.3.2.3.1.1.1.5.1.1"><p id="smn_api_53005__p42023897"><strong id="smn_api_53005__b842352706191030">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.119999999999997%" id="mcps1.3.2.3.1.1.1.5.1.2"><p id="smn_api_53005__p48492497"><strong id="smn_api_53005__b593421527191713">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.51%" id="mcps1.3.2.3.1.1.1.5.1.3"><p id="smn_api_53005__p35578198"><strong id="smn_api_53005__b84235270619112">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="34.33%" id="mcps1.3.2.3.1.1.1.5.1.4"><p id="smn_api_53005__p63261775"><strong id="smn_api_53005__b84235270619115">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="smn_api_53005__row59293887"><td class="cellrowborder" valign="top" width="25.040000000000003%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="smn_api_53005__p38075525">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.119999999999997%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="smn_api_53005__p64218721">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.51%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="smn_api_53005__p34333880">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.33%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="smn_api_53005__p16674844155319">Project ID</p>
|
|
<p id="smn_api_53005__p29580916">See <a href="smn_api_66000.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="smn_api_53005__row22543082"><td class="cellrowborder" valign="top" width="25.040000000000003%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="smn_api_53005__p14050320">message_template_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.119999999999997%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="smn_api_53005__p64334135">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.51%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="smn_api_53005__p43682438">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.33%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="smn_api_53005__p48616614">Unique resource ID of a topic. You can obtain it by referring to <a href="smn_api_53004.html">Querying Message Templates</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="smn_api_53005__section20292006"><h4 class="sectiontitle">Request</h4><div class="p" id="smn_api_53005__p40452337124612">Example request<pre class="screen" id="smn_api_53005__screen59098850105230">GET https://{SMN_Endpoint}/v2/{project_id}/notifications/message_template/57ba8dcecda844878c5dd5815b65d10f</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="smn_api_53005__section48410331"><h4 class="sectiontitle">Response</h4><ul id="smn_api_53005__ul18974699"><li id="smn_api_53005__li36554565">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="smn_api_53005__table60555637" frame="border" border="1" rules="all"><thead align="left"><tr id="smn_api_53005__row55059575"><th align="left" class="cellrowborder" valign="top" width="29.020000000000003%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="smn_api_53005__p30640599"><strong id="smn_api_53005__b2007298018">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.69%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="smn_api_53005__p65969435"><strong id="smn_api_53005__b870393070">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="41.29%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="smn_api_53005__p41924012"><strong id="smn_api_53005__b1453514347">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="smn_api_53005__row51318482"><td class="cellrowborder" valign="top" width="29.020000000000003%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="smn_api_53005__p63156409">message_template_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.69%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="smn_api_53005__p15395467">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.29%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="smn_api_53005__p39073330">Template ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="smn_api_53005__row30299850"><td class="cellrowborder" valign="top" width="29.020000000000003%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="smn_api_53005__p38368787">message_template_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.69%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="smn_api_53005__p20864077">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.29%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="smn_api_53005__p12268704">Template name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="smn_api_53005__row139520593919"><td class="cellrowborder" valign="top" width="29.020000000000003%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="smn_api_53005__p33048293">protocol</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.69%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="smn_api_53005__p18228205714104">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.29%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="smn_api_53005__p1114082">Protocol supported by the template</p>
|
|
<p id="smn_api_53005__p13331422755">Currently, the following protocols are supported:</p>
|
|
<ul id="smn_api_53005__ul88352301953"><li id="smn_api_53005__smn_api_53001_li1915283525718"><strong id="smn_api_53005__smn_api_53001_b122581017374">email</strong></li><li id="smn_api_53005__smn_api_53001_li955352032817"><strong id="smn_api_53005__smn_api_53001_b1938219133716">default</strong></li><li id="smn_api_53005__smn_api_53001_li031203718574"><strong id="smn_api_53005__smn_api_53001_b23671526885">sms</strong></li><li id="smn_api_53005__smn_api_53001_li1682010496573"><strong id="smn_api_53005__smn_api_53001_b185159332910">http</strong> and <strong id="smn_api_53005__smn_api_53001_b25282033899">https</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="smn_api_53005__row48741777"><td class="cellrowborder" valign="top" width="29.020000000000003%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="smn_api_53005__p55769855">tag_names</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.69%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="smn_api_53005__p21064410">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.29%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="smn_api_53005__p1311575516403">Variable list</p>
|
|
<p id="smn_api_53005__p28495625">The variable name will be quoted in braces ({}) in the template. When you use a template to send messages, you can replace the variable with any content.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="smn_api_53005__row36671901"><td class="cellrowborder" valign="top" width="29.020000000000003%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="smn_api_53005__p17633966">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.69%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="smn_api_53005__p19065136">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.29%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="smn_api_53005__p772170">Time when the template was created</p>
|
|
<p id="smn_api_53005__p17515094173556">The UTC time is in <em id="smn_api_53005__i2155151513511">YYYY-MM-DDTHH:MM:SSZ</em> format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="smn_api_53005__row26041554"><td class="cellrowborder" valign="top" width="29.020000000000003%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="smn_api_53005__p28991153">update_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.69%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="smn_api_53005__p66582052">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.29%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="smn_api_53005__p24437140">Last time when the template was updated</p>
|
|
<p id="smn_api_53005__p3896935217360">The UTC time is in <em id="smn_api_53005__i1557451817351">YYYY-MM-DDTHH:MM:SSZ</em> format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="smn_api_53005__row30826283"><td class="cellrowborder" valign="top" width="29.020000000000003%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="smn_api_53005__p13901009">content</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.69%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="smn_api_53005__p52239951">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.29%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="smn_api_53005__p3577678">Template content</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="smn_api_53005__row17748175775810"><td class="cellrowborder" valign="top" width="29.020000000000003%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="smn_api_53005__p55439693194741">request_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.69%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="smn_api_53005__p61430126194741">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.29%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="smn_api_53005__p9784341194741">Request ID, which is unique</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="smn_api_53005__li57991080">Example response<pre class="screen" id="smn_api_53005__screen33742506194644">{
|
|
"message_template_name": "confirm_message",
|
|
"protocol": "https",
|
|
"update_time": "2016-08-02T08:22:25Z",
|
|
"create_time": "2016-08-02T08:22:20Z",
|
|
"request_id": "ba79ca8f794f4f50985ce7b98a401b47",
|
|
"tag_names": [
|
|
"topic_id_id4"
|
|
],
|
|
"content": "(1/24)You are invited to subscribe to topic({topic_id_id4}). Click the following URL to confirm subscription:(If you do not want to subscribe to this topic, ignore this message.)",
|
|
"message_template_id": "57ba8dcecda844878c5dd5815b65d10f"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="smn_api_53005__section33039800"><h4 class="sectiontitle">Returned Value</h4><p id="smn_api_53005__p19217855">See <a href="smn_api_63002.html">Returned Value</a>.</p>
|
|
</div>
|
|
<div class="section" id="smn_api_53005__section73211020122511"><h4 class="sectiontitle">Error Codes</h4><p id="smn_api_53005__p9759142919265">See <a href="smn_api_64000.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="smn_api_53000.html">Template Operations</a></div>
|
|
</div>
|
|
</div>
|
|
|