Enviar Mensaje

Ejemplo de Envio

El formato de request es JSON

POST https://api.itexting.com/{API_KEY}/sms

Authorization: Bearer {JWT_AUTH_TOKEN}
Content-Type: application/json
{
    "to": "1234567890",
    "text":{
        "body":"Mi primer SMS"
    }
}

Parametro de Envio

El formato de envio es JSON

NombreTipoDescripcionRequerido(S/N)
fromStringPermite identificar el originador. Utilizado para especificar un numero asignado, un Alfanumerico, un short code exclusivo o compartido. Si no se especifica se utiliza el identificador predeterminado a la cuenta.N
toStringNumero de destino en formato internacionalS
internal_idStringIdentificador interno. Permite vincular mensajes con identificadores de sistemas externosN
textTextObjeto TextS

Objeto Text

NombreTipoDescripcionRequerido(S/N)
bodyStringTexto del mensaje de texto, que puede contener formato y URL. Para obtener más información, consulta las secciones sobre enviar URL en mensajes de texto y aplicar formato en mensajes de textS
data_codingNumericoEs el valor de codificacion del campo mensaje, valores posibles:
Si no se especifica un parametro: auto detección (valor por defecto). Si el mensaje tiene menos de 70 caracteres se utilizara UNICODE como valor de preferencia.
0: GSM7 o Latin 1 (ISO/IEC 8859-1), dependera de la codificacion de la region.
3: Latin 1 (ISO/IEC 8859-1)
8: Unicode/USC2
N
multipartBooleanPermite bloquear el envio de mensajes largos, valores posibles: true: permitido (valor por defecto) false: no permitidoN

Parametro de Respuesta Valida

El formato de envio es JSON

NombreTipoDescripcion
message_idNumericoEs el identificador único del mensaje; permite su reconocimiento para seguimientos posteriores.
dateFechaEs la fecha y hora en que el mensaje fue recibido por la plataforma. El formato es timestamp UTC.
countNumericoCantidad de partes del mensaje para el caso en el que se permitan mensajes largos "multipart"
submitNumericoEl valor que retorna es el resultado del envío del requerimiento; es decir; indica si el mensaje ha sido colocado satisfactoriamente en la bandeja de mensajes por enviar en la plataforma. Valores posibles:
0: Error
1: Submitted
2: Queued
data_codingNumericoFormato Seleccionado, si el mensaje tiene menos de 70 caracteres se utilizara UNICODE como valor de preferencia
lengthNumericoLongitud de caracteres del mensaje

Ejemplo de Respuesta Valida Codigo de HTTP 200

HTTP/1.1 200 OK
Content-Type: application/json
{
    "message_id": "UUID",
    "date": 1691183049056,
    "count": 1
}

Ejemplo de Envio Avanzado

El formato de request es JSON

POST https://api.itexting.com/{API_KEY}/sms

Authorization: Bearer {JWT_AUTH_TOKEN}
Content-Type: application/json
{
    "from": "77777",
    "to": "1234567890",
    "internal_id": "1732-e3ef1a-23569",
    "text":{
        "multipart": false,
        "data_coding": 0,
        "body": "Mi primer SMS Avanzado"
    }
}

Parametro de Respuesta con Error

El formato de envio es JSON

NombreTipoDescripcion
dateFechaEs la fecha y hora del evento. El formato es timestamp.
errorStringEl valor retornado identifica el error por el que el mensaje ha sido rechazado por la plataforma de envío de mensajes. En caso de que el requerimiento ha sido aceptado el valor es null.
codeStringCodigo de error o codigo valido de envio

Ejemplo de Respuesta con codigo de error

HTTP/1.1 402 Reserved
Content-Type: application/json
{
    "error": "no credit available",
    "date": 1691183049056,
    "code": "12"
}

Parametro de Envio BULK

El formato de envio es JSON

NombreTipoDescripcionRequerido(S/N)
nameStringNombre del envio Bulk.S
fromStringPermite identificar el originador. Utilizado para especificar un numero asignado, un Alfanumerico, un short code exclusivo o compartido. Si no se especifica se utiliza el identificador predeterminado a la cuenta.N
posted_atTimestampFecha y Hora en que el bulk comenzara a enviar los mensajes. Si no se especifica 'posted_at' el envio comenzara de manera inmediata una vez enviado el requerimiento.N
destinationsDestinationArray de Objetos DestinationS
textTextObjeto TextS

Objeto Text

NombreTipoDescripcionRequerido(S/N)
bodyStringTexto del mensaje de texto, que puede contener formato y URL. Para obtener más información, consulta las secciones sobre enviar URL en mensajes de texto y aplicar formato en mensajes de textS
data_codingNumericoEs el valor de codificacion del campo mensaje, valores posibles:
Si no se especifica un parametro: auto detección (valor por defecto). Si el mensaje tiene menos de 70 caracteres se utilizara UNICODE como valor de preferencia.
0: GSM7 o Latin 1 (ISO/IEC 8859-1), dependera de la codificacion de la region.
3: Latin 1 (ISO/IEC 8859-1)
8: Unicode/USC2
N
multipartBooleanPermite bloquear el envio de mensajes largos, valores posibles: true: permitido (valor por defecto) false: no permitidoN

Objeto Destination

NombreTipoDescripcionRequerido(S/N)
toStringNumero de destino en formato internacionalS
internal_idStringIdentificador interno. Permite vincular mensajes con identificadores de sistemas externosN

Ejemplo de Envio BULK

POST https://api.itexting.com/{API_KEY}/sms/bulk

Authorization: Bearer {JWT_AUTH_TOKEN}
Content-Type: application/json
{
    "name": "INTERMAX TEST BULK",
    "from": "77777",
    "type": "text",
    "text": {
        "multipart": false,
        "data_coding": 0,
        "body": "Hola todos"  
    },
    "posted_at": 1695953421000,
    "destinations":[
        {
            "to": 1234567890,
            "internal_id": "id-cliente-1"
        },
        {
            "to": 1234567891,
            "internal_id": "id-cliente-2"
        },
        {
            "to": 1234567892,
            "internal_id": "id-cliente-3"
        },
        {
            "to": 1234567893,
            "internal_id": "id-cliente-4"
        }
    ]
}

Codigos de Error

ErrorDescripcion
010Error interno
011Rechazo de Operador
012Gateway no disponible
013Formato o PDU del mensaje invalido
014Servicio Rest no disponible
015Operador no responde
016Ruta no disponible
017Codificacion no disponible.
018Multipart o Mensajes largos no permitido.
019API KEY Invalida
020Error en Cuenta
021Cuenta desactivada
022Cuenta bloqueada
023Usuario no vinculado a la cuenta
024Cuenta no encontrada
025Cuenta sin credito
026Formato de destino invalido
027Cola de mensajes full

Codigos de Servidor HTTP

ErrorDescripcion
200Solicitud procesada con exito
400Solicitud invalida.
401Acceso no autorizado.
402Sin credito, Pago no autorizado o Se requiere un pago.
403Cuenta desactivada, bloqueada,
404Recurso no encontrado. Usuario no vinculado a la cuenta, Consumidor no encontrado,
429Recurso bloqueado por demasiadas solicitudes. La mayoria de las veces involucra a una o varias IPs que intentan acceder a recursos que no procesan con exito la solicitud (200 OK)
500Error interno del sistema.
503El servicio no se encuentra disponible.
504El servidor no puede completar la solicitud a tiempo. Sin embargo, el problema puede deberse a problemas de conectividad de red de servidor a servidor o un servidor que está caído. Tambien puede deberse a problemas en el extremo del cliente, como problemas de conexión a Internet

Timeout en solicitudes HTTP

EL timeout por cada solitud HTTP debe configurarse en 5000ms, sin embargo, las solicitudes son procesadas entre 20ms y 100ms, aunque en ocasiones, por razones asocidadas a mantenimiento, sobrecarga, problemas de red, problemas de latencia en operadores externos u otros problemas de latencia estos tiempos pueden incrementarse. No se consideran en este calculo los tiempos propios de los enlaces a internet, que por lo general, en una misma region oscilan entre 5ms a 30ms.