Actualizar configuración de plantilla
Actualiza una configuración de plantilla existente, permitiendo modificar el nombre, el tipo, el contenido, los países de envío y la información de la firma. Tras la actualización, la plantilla vuelve al estado "Pendiente de revisión".
URL de solicitud
PUT https://smsapi.engagelab.com/v1/template-configs/:templateId
Validación de la llamada
Consulta Validación de la llamada para saber cómo realizar la autenticación de la API.
Ejemplo de solicitud
Encabezado de la solicitud
PUT /v1/template-configs/123456789 HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
PUT /v1/template-configs/123456789 HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
Este bloque de código se muestra en una ventana flotante
Cuerpo de la solicitud
{
"template_name": "Plantilla de notificación de pedido",
"template_type": "utility",
"template_content": "Su pedido {order_no} ha sido enviado y se espera que se entregue antes de {delivery_time}",
"country_codes": "CN,US",
"add_signature": true,
"sign_id": "987654321",
"sign_position": 2
}
{
"template_name": "Plantilla de notificación de pedido",
"template_type": "utility",
"template_content": "Su pedido {order_no} ha sido enviado y se espera que se entregue antes de {delivery_time}",
"country_codes": "CN,US",
"add_signature": true,
"sign_id": "987654321",
"sign_position": 2
}
Este bloque de código se muestra en una ventana flotante
Parámetros de solicitud
Parámetros de ruta
| Parámetro | Tipo | Opciones | Descripción |
|---|---|---|---|
| templateId | String | Obligatorio | ID de la plantilla |
Parámetros del cuerpo de la solicitud
| Parámetro | Tipo | Opciones | Descripción |
|---|---|---|---|
| template_name | String | Obligatorio | Nombre de la plantilla, máximo 255 caracteres |
| template_type | String | Obligatorio | Tipo de plantilla: utility (notificación), marketing (marketing) |
| template_content | String | Obligatorio | Contenido de la plantilla, no puede contener: 【, 】, 、, 测试, test, [, ] |
| country_codes | String | Obligatorio | Códigos de los principales países de envío, separados por comas |
| add_signature | Boolean | Opcional | Si se añade firma, false por defecto |
| sign_id | String | Obligatorio condicional | Obligatorio cuando add_signature es true, ID de la firma |
| sign_position | Integer | Obligatorio condicional | Obligatorio cuando add_signature es true, posición de la firma: 1-prefijo, 2-sufijo |
Parámetros de respuesta
Respuesta correcta
El código de estado HTTP es 200 y el cuerpo de la respuesta contiene los siguientes campos:
| Campo | Tipo | Descripción |
|---|---|---|
| code | Integer | Código de estado, 0 indica éxito |
| message | String | Descripción del estado |
Ejemplo correcto
{
"code": 0,
"message": "success"
}
{
"code": 0,
"message": "success"
}
Este bloque de código se muestra en una ventana flotante
Respuesta con error
El código de estado HTTP es 4xx/5xx y el cuerpo de la respuesta contiene los siguientes campos:
| Campo | Tipo | Descripción |
|---|---|---|
| code | Integer | Código de error |
| message | String | Detalle del error |
Ejemplo de error
{
"code": 400,
"message": "can not update pending status template"
}
{
"code": 400,
"message": "can not update pending status template"
}
Este bloque de código se muestra en una ventana flotante
Códigos de error
| Código de error | http code | Descripción |
|---|---|---|
| 400 | 400 | Error de parámetros o de lógica de negocio |
| 500 | 500 | Error interno del servidor |
Mensajes de error comunes:
invalid templateId: formato del ID de plantilla incorrectotemplate config not exist: la configuración de plantilla no existecan not update pending status template: no se puede actualizar una plantilla en estado pendiente de revisiónthere are pending or running plans using current template, can not update: hay planes pendientes de envío o en ejecución que usan esta plantilla, no se puede actualizarsign config not exist: la configuración de firma no existesign status is not approved, can not use: la firma no está aprobada y no se puede usar
Consideraciones
- No se puede actualizar una plantilla en estado pendiente de revisión
- Si hay planes de mensajes pendientes de envío o en ejecución que usan esta plantilla, no se puede actualizar
- Tras la actualización, la plantilla vuelve al estado "Pendiente de revisión" (status=1)
- Si se añade una firma, esta debe estar en estado aprobado
- El contenido de la plantilla no puede contener caracteres prohibidos:
【,】,、,测试,test,[,] - Tanto el ID de la plantilla como el de la firma son números de tipo cadena
Apéndice
Estado de la configuración de plantilla (status)
| Valor | Descripción |
|---|---|
| 1 | Pendiente de revisión |
| 2 | Revisión aprobada |
| 3 | Revisión rechazada |
Tipo de plantilla (template_type)
| Valor | Descripción |
|---|---|
| utility | Notificación |
| marketing | Marketing |
Posición de la firma (sign_position)
| Valor | Descripción |
|---|---|
| 0 | Sin firma |
| 1 | Prefijo |
| 2 | Sufijo |










