Eliminar configuración de firma

Elimina la configuración de firma indicada. Si la firma está siendo usada por un plan de mensajes (en estado pendiente de envío o en ejecución), no se puede eliminar.

URL de solicitud

DELETE 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

DELETE /v1/sign-configs/987654321 HTTP/1.1 Content-Type: application/json Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
              
              DELETE /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 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": "there are pending or running plans using current sign, can not update" }
              
              {
  "code": 400,
  "message": "there are pending or running plans using current sign, can not update"
}

            
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
  • there 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 eliminar

Consideraciones

  1. Si hay planes de mensajes pendientes de envío o en ejecución que usan esta firma, no se puede eliminar
  2. El ID de la firma es un número de tipo cadena
Icon Solid Transparent White Qiyu
Contacto