Obtener detalle de configuración de plantilla

Obtén la información detallada de la configuración de plantilla según el ID de plantilla, incluyendo el nombre, el tipo, el contenido, el estado de revisión, etc.

URL de solicitud

GET 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

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

              
              GET /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

Ninguno

Parámetros de solicitud

Parámetros de ruta

Parámetro	Tipo	Opciones	Descripción
templateId	String	Obligatorio	ID de la plantilla

Parámetros de respuesta

Respuesta correcta

El código de estado HTTP es 200 y el cuerpo de la respuesta es el objeto de configuración de plantilla:

Campo	Tipo	Descripción
template_id	String	ID de la plantilla
template_name	String	Nombre de la plantilla
template_type	String	Tipo de plantilla: `utility` (notificación), `marketing` (marketing)
template_content	String	Contenido de la plantilla
country_codes	String	Códigos de los principales países de envío, separados por comas
status	Integer	Estado: 1-pendiente de revisión, 2-revisión aprobada, 3-revisión rechazada
sign_id	String	ID de la firma (opcional)
sign_name	String	Nombre de la firma (opcional)
sign_position	Integer	Posición de la firma: 0-ninguna, 1-prefijo, 2-sufijo (opcional)
sign_status	Integer	Estado de la firma (opcional)
audit_remark	String	Comentario de revisión
created_time	Integer	Hora de creación (marca de tiempo Unix)
updated_time	Integer	Hora de actualización (marca de tiempo Unix)

Ejemplo correcto

{ "template_id": "123456789", "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", "status": 2, "sign_id": "987654321", "sign_name": "Nombre de la empresa", "sign_position": 2, "sign_status": 2, "audit_remark": "", "created_time": 1699000000, "updated_time": 1699000000 }

              
              {
  "template_id": "123456789",
  "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",
  "status": 2,
  "sign_id": "987654321",
  "sign_name": "Nombre de la empresa",
  "sign_position": 2,
  "sign_status": 2,
  "audit_remark": "",
  "created_time": 1699000000,
  "updated_time": 1699000000
}

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": "invalid templateId" }

              
              {
  "code": 400,
  "message": "invalid templateId"
}

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 incorrecto
template config not exist: la configuración de plantilla no existe

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