Crear configuración de firma

Crea una nueva configuración de firma (Sender ID) para mostrar el identificador del remitente en los SMS. Tras la creación, la firma queda en estado "Pendiente de revisión" y solo se puede usar después de aprobarse.

URL de solicitud

POST https://smsapi.engagelab.com/v1/sign-configs

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

              
              POST /v1/sign-configs  HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

Cuerpo de la solicitud

              
              {
  "sign_name": "Nombre de la empresa"
}

            

Parámetros de solicitud

Parámetros de respuesta

Respuesta correcta

El código de estado HTTP es 200 y el cuerpo de la respuesta contiene los siguientes campos:

Ejemplo correcto

              
              {
  "sign_id": "987654321"
}

            

Respuesta con error

El código de estado HTTP es 4xx/5xx y el cuerpo de la respuesta contiene los siguientes campos:

Ejemplo de error

              
              {
  "code": 400,
  "message": "sign_name already exist"
}

            

Códigos de error

Mensajes de error comunes:

• sign_name already exist: el nombre de la firma ya existe

Consideraciones

1. Tras crearse, la firma queda en estado "Pendiente de revisión" (status=1) y solo se puede usar después de aprobarse
2. El nombre de la firma no puede repetirse dentro de un mismo negocio
3. El nombre de la firma no puede contener caracteres prohibidos: 【, 】, [, ]
4. El ID de la firma es un número de tipo cadena

Apéndice

Estado de la configuración de firma (status)