更新模板配置

更新已存在的模板配置，支持修改模板名称、类型、内容、发送国家及签名信息。更新后模板状态会变回"待审核"。

调用地址

PUT https://smsapi.engagelab.com/v1/template-configs/:templateId

调用验证

请参考 调用验证 了解如何进行 API 鉴权。

请求示例

请求头

              
              PUT /v1/template-configs/123456789  HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

请求体

              
              {
  "template_name": "订单通知模板",
  "template_type": "utility",
  "template_content": "您的订单{order_no}已发货，预计{delivery_time}送达",
  "country_codes": "CN,US",
  "add_signature": true,
  "sign_id": "987654321",
  "sign_position": 2
}

            

请求参数

路径参数

请求体参数

返回参数

成功返回

http 状态码为 200，响应体包含字段如下：

成功示例

              
              {
  "code": 0,
  "message": "success"
}

            

失败返回

http 状态码为 4xx/5xx，响应体包含字段如下：

异常示例

              
              {
  "code": 400,
  "message": "can not update pending status template"
}

            

错误码

常见错误信息：

• invalid templateId：模板 ID 格式错误
• template config not exist：模板配置不存在
• can not update pending status template：待审核状态的模板不能更新
• there are pending or running plans using current template, can not update：存在使用该模板的待发送或运行中的计划，不能更新
• sign config not exist：签名配置不存在
• sign status is not approved, can not use：签名状态未审核通过，不能使用

注意事项

1. 待审核状态的模板不能更新
2. 如果存在待发送或运行中的消息计划使用该模板，则不能更新
3. 更新后模板状态会变回"待审核"（status=1）
4. 如果添加签名，签名必须是已审核通过状态
5. 模板内容不能包含禁用字符：【、】、、、测试、test、[、]
6. 模板和签名的 ID 都是字符串类型的数字

附录

模板配置状态 (status)

模板类型 (template_type)

签名位置 (sign_position)