Obtener detalle de configuración de firma

Obtén la información detallada de la configuración de firma según el ID de firma, incluyendo el nombre de la firma, el estado de revisión, el número de plantillas asociadas, etc.

URL de solicitud

GET https://smsapi.engagelab.com/v1/sign-configs/:signId

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/sign-configs/987654321 HTTP/1.1 Content-Type: application/json Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

              
              GET /v1/sign-configs/987654321  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
signId	String	Obligatorio	ID de la firma

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 firma:

Campo	Tipo	Descripción
sign_id	String	ID de la firma
sign_name	String	Nombre de la firma
status	Integer	Estado: 1-pendiente de revisión, 2-revisión aprobada, 3-revisión rechazada
related_template_count	Integer	Número de plantillas asociadas
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

{ "sign_id": "987654321", "sign_name": "Nombre de la empresa", "status": 2, "related_template_count": 5, "audit_remark": "", "created_time": 1699000000, "updated_time": 1699000000 }

              
              {
  "sign_id": "987654321",
  "sign_name": "Nombre de la empresa",
  "status": 2,
  "related_template_count": 5,
  "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 signId" }

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

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 signId: formato del ID de firma incorrecto
sign config not exist: la configuración de firma no existe

Apéndice

Estado de la configuración de firma (status)

Valor	Descripción
1	Pendiente de revisión
2	Revisión aprobada
3	Revisión rechazada