获取模板详情 - ShowTemplate
功能介绍
该接口用于用户查询已创建的模板详情。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/msgsms/templates/{id}
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
id | 是 | String | 模板主键ID,对应表5中的id |
project_id | 是 | String | 项目ID,参考“获取帐号、用户、项目的名称和ID” |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
Content-Type | 是 | String | 请求体参数类型,该字段必须设置为:application/json |
X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
响应参数
状态码: 200
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
id | 否 | String | 模板主键ID |
create_time | 否 | String | 创建时间[yyyy-MM-dd HH:mm:ss] |
update_time | 否 | String | 更新时间[yyyy-MM-dd HH:mm:ss] |
customer_id | 否 | String | 租户customer id |
tenant | 否 | - | |
template_name | 否 | String | 模板名称 |
template_id | 否 | String | 模板ID 注:只有模板审核通过之后才有值,未审核通过时,该值为空 |
template_type | 否 | String | 模板类型。只有地域为国内,且universal_template参数值不为1时,该字段有效。universal_template参数值为0,则模板类型继承绑定签名的签名类型。支持枚举值:
|
app_name | 否 | String | 应用名称 |
app_key | 否 | String | 应用key |
sign_id | 否 | String | 签名ID |
template_content | 否 | String | 模板内容 |
has_variable | 否 | String | 是否有变量
|
template_desc | 否 | String | 申请描述 |
review_desc | 否 | String | 审核意见 |
review_order | 否 | String | 审核人账号 |
flow_status | 否 | String | 流程状态
|
universal_template | 否 | String | 是否是通用模板
|
status | 否 | String | 模板状态
|
region | 否 | String | 地域
|
brackets | 否 | String | 中括号类型。支持枚举值:
|
site | 否 | String | 站点,当前该参数暂不支持使用
|
urge_status | 否 | String | 催审状态
|
urge_time | 否 | String | 催审时间 |
urge_desc | 否 | String | 催审描述 |
send_country1 | 否 | Integer | 发送国家1 |
send_country2 | 否 | Integer | 发送国家2 |
send_country3 | 否 | Integer | 发送国家3 |
is_support_multiomp | 否 | Boolean | 是否支持多OMP |
country_name | 否 | String | 国家名称列表,返回发送国家前三名的国家名称,国家名称间以"~"分隔 |
请求示例
获取模板详情,请求方式:GET ,请求URL:/v2/{project_id}/msgsms/templates/{id},路径参数:id,project_id,请求头参数:X-Auth-Token,Content-Type。
GET /v2/845ada5bc7444f1295cd517af0123da1/msgsms/templates/460a2427-37eb-4229-bee9-0eba4d8a897f Host: 100.85.***.***:30300 Content-Type: application/json X-Auth-Token:******
响应示例
{
"create_time": "2022-08-12 07:40:36",
"customer_id": "******c55c3c4526b2ed7a0213bc9871",
"id": "******27-37eb-4229-bee9-0eba4d8a897f",
"template_id":"********441aa84cb34849f84c3a"
"template_type": "NOTIFY_TYPE",
"template_name": "auto_test789",
"app_key": "******3baZf4c856O4Qrbqvui3K2",
"sign_id": "******b9-4141-4e2d-9838-14889c32a4bf",
"template_content": "测试",
"has_variable": "No",
"flow_status": "Reviewing",
"status": "Normal",
"universal_template": 0,
"urge_status": "NO",
} 返回值
返回值 | 描述 |
|---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | System error |

