SMS

Solicitud HTTP para enviar SMS

POST https://send.obmessage.ai/api/v1/sms
X-Api-Key: {{API_KEY}}
Content-Type: application/json

{
    "phone": "string",
    "message": "string",
    "reference": "string",
    "group": "string",
    "template_id": "string",
    "not_sent_after": "string",
    "fields": [
        {
            "name": "string",
            "value": "string",
            "short": true
        }
    ]
}

Pruébalo en Postman

Descripción de los campos

Campo	Descripción	Obligatorio
phone	Número telefónico del destinatario, en formato E.164.	Sí
message	Contenido del mensaje que será enviado.	No
reference	ID de referencia del mensaje.	No
template_id	ID de la plantilla creada. Si se envía este campo, se ignora message.	No
not_sent_after	Todo mensaje procesado después de la hora indicada se marcará con estado cancelled. El formato de hora debe ser UTC. Este campo no es obligatorio, pero es recomendable para evitar envíos fuera del horario regulado. Ver el apartado de políticas.	No
group	ID de referencia grupal del mensaje.	No
fields	Arreglo de campos dinámicos asociados al mensaje.	No
fields.name	Nombre del campo.	Sí
fields.value	Valor correspondiente al campo.	Sí
fields.short	Indica si el valor del campo será acortado.	No

Trama JSON de ejemplo

POST https://send.obmessage.ai/api/v1/sms
X-Api-Key: {{API_KEY}}
Content-Type: application/json

{
    "phone": "+18099999999",
    "message": "Hello World",
    "reference": "8151",
    "group": "obm-api",
    "template_id": "60b7720a-8129-4f31-9ea9-457f77cde3de",
    "not_sent_after": "2024-02-12T23:30:59Z",
    "fields": [
        {
            "name": "cuota",
            "value": "138.98"
        }
    ]
}

Pruébalo en Postman

Respuesta

Si el mensaje se envía correctamente, se retorna el código 200 OK con la siguiente trama JSON:

{
    "id": "string",
    "phone": "string",
    "reference": "string",
    "group": "string",
    "status": "string",
    "created_at": "string"
}

Descripción de los campos de la respuesta

Campo	Descripción
id	Código de identificación del mensaje.
phone	Número telefónico, correspondiente al mismo valor enviado.
reference	ID de referencia del mensaje, correspondiente al mismo valor enviado.
group	ID de referencia grupal del mensaje, correspondiente al mismo valor enviado.
created_at	Fecha en la que se recibe el mensaje, en formato RFC 3339.
status	Estado actual del mensaje. Los estados son: received y error.