Actualizar configuración de firma
Actualiza una configuración de firma existente, permitiendo modificar el nombre de la firma. Tras la actualización, la firma vuelve al estado "Pendiente de revisión".
URL de solicitud
PUT 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
PUT /v1/sign-configs/987654321 HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
PUT /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
{
"sign_name": "Nombre de la empresa"
}
{
"sign_name": "Nombre de la empresa"
}
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 |
|---|---|---|---|
| signId | String | Obligatorio | ID de la firma |
Parámetros del cuerpo de la solicitud
| Parámetro | Tipo | Opciones | Descripción |
|---|---|---|---|
| sign_name | String | Obligatorio | Nombre de la firma, de 2 a 60 caracteres, no puede contener: 【, 】, [, ] |
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 sign"
}
{
"code": 400,
"message": "can not update pending status sign"
}
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 incorrectosign config not exist: la configuración de firma no existesign_name already exist: el nombre de la firma ya existecan not update pending status sign: no se puede actualizar una firma en estado pendiente de revisiónthere are pending or running plans using current sign, can not update: hay planes pendientes de envío o en ejecución que usan esta firma, no se puede actualizar
Consideraciones
- No se puede actualizar una firma en estado pendiente de revisión
- Si hay planes de mensajes pendientes de envío o en ejecución que usan esta firma, no se puede actualizar
- Tras la actualización, la firma vuelve al estado "Pendiente de revisión" (status=1)
- El nombre de la firma no puede contener caracteres prohibidos:
【,】,[,] - El ID de la firma es un número de tipo cadena
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 |










