Manual API HTTP
De Proyecto Marketing-Movil.com
OBJETIVO
- Este manual permitirá a los desarrolladores integrar el módulo de envíos de su aplicación con nuestra HTTP API INTERFACE para realizar envíos de SMS, consulta de créditos y consulta de estado de un envío de SMS de forma fácil.
REQUERIMIENTOS
- Para una completa comprensión de este manual y una rápida y fácil integración de su módulo de ventas se requiere tener alguno de los siguientes conocimientos:
- Conocimientos de programación Web
- Conocimientos de comunicación via Sockets
- Para tener acceso a este servicio es necesario tener una cuenta en marketing-movil.com
DESCRIPCIÓN
- Este en este manual se describe la implementación de la conexión a la plataforma marketing-movil.com mediante el protocolo HTTP para el envío de SMS, consulta de créditos y consulta de estado de un envío de SMS de forma rápida, fácil y eficiente.
PANEL DE CONTROL
- Para acceder al panel de control debe visitar http://www.marketing-movil.com y acceder con sus datos de registro.
- Desde dicho panel de control podrá recargar sus créditos, personalizar su remitente, cambiar su contraseña o realizar envíos SMS.
INTEGRANDO SUS APLICACIONES
- Consideraciones Generales
- Para comunicarse con nuestra HTTP API INTERFACE debe enviar las solicitudes mediante POST o GET.
REALIZAR ENVIOS SMS
| Parámetro
| Nombre
| Descripción
|
| UN
| User Name
| ID o Email del usuario que se registró en marketing-movil.com
|
| P
| Password
| Contraseña que utiliza para acceder a su cuenta
|
| DA
| Destination Address
| Número de teléfono del destinatario con el código internacional p.ej 34666112255 para los números de España.
|
| M
| Message
| Mensaje que desea enviar.
|
| SA
| Source Address
| Remitente personalizado.Máximo 16 caracteres numéricos u 11 caracteres alfanumericos. Si se omite este parámetro se enviará el mensaje con el remitente que se registró en la plataforma.
|
- Éstos parámetros deberán ser enviados a la siguiente URL:
- https://www.marketing-movil.com/API/envios.php
- Por ejemplo:
- https://www.marketing-movil.com/API/envios.php?UN={username}&P={userpasswd}&DA={destination_address}&M={message}&SA={source_address}
RESPUESTA DE ENVIO DE SMS
- La API retornará una cadena con el MSGID del SMS enviado.
- Ejemplo de una respuesta satisfactoria:
- HTTP Header: 200 OK
- Content: OK 123456789
CONSULTAR ESTADO DE ENVIO DE SMS
| Parámetro
| Nombre
| Descripción
|
| UN
| User Name
| ID o Email del usuario que se registró en marketing-movil.com
|
| P
| Password
| Contraseña que utiliza para acceder a su cuenta
|
| MSGID
| Message ID
| Valor retornado cuando el envío del sms ha sido satisfactorio.
|
- Éstos parámetros deberán ser enviados a la siguiente URL:
- https://www.marketing-movil.com/API/estado.php
- Por ejemplo:
- https://www.marketing-movil.com/API/estado.php?UN={username}&P={userpasswd}&MSGID={message_id}
RESPUESTAS DE CONSULTA DE SMS
- La API retornará una cadena con el estado del SMS enviado.
| Parámetro
| Descripción
|
| MSGID
| ID del mensaje.
|
| DESTINATION
| El numero de teléfono del destinatario del sms.
|
| STATUS
| Valor numérico
0 = ENVIADO
1 = RECIBIDO
3 = Teléfono no válido o destino fuera de nuestra cobertura de envíos.
La plataforma actualiza este valor cada 5-10 min.
|
| SEND_DATETIME
| Hora de envío del sms.
|
| RECEIPT_DATETIME
| Hora en que el sms fue recibido por el destinatario, este valor nos lo facilita la operadora del destinatario la hora siempre en el uso horario GMT +01:00.
|
- Ejemplo de una respuesta satisfactoria:
- HTTP Header: 200 OK
- Content: MSGID: {message_id} DESTINATION: {telephone_number} STATUS: 1 SEND_DATETIME: 2009-04-15 11:24:46 RECEIPT_DATETIME: 2009-04-15 11:26:46
CONSULTAR CRÉDITOS DISPONIBLES
| Parámetro
| Nombre
| Descripción
|
| UN
| User Name
| ID o Email del usuario que se registró en marketing-movil.com
|
| P
| Password
| Contraseña que utiliza para acceder a su cuenta
|
- Éstos parámetros deberán ser enviados a la siguiente URL:
- https://www.marketing-movil.com/API/creditos.php
- Por ejemplo:
- https://www.marketing-movil.com/API/creditos.php?UN={username}&P={userpasswd}
RESPUESTA DE CONSULTA DE CRÉDITOS
- La API retornará una cadena con los créditos disponibles.
- Ejemplo de una respuesta satisfactoria:
- HTTP Header: 200 OK
- Content: OK demo@soydigital.com 180 CREDITOS
ERRORES
Respuesta de ERROR 1: Usuario o Contraseña no válidos
HTTP Header: 401 Unauthorized
Content: ERR -10
Respuesta de ERROR 2: No tiene créditos suficientes
HTTP Header: 402 Payment Required
Content: ERR -5
Respuesta de ERROR 3: Error del sistema, intentar de nuevo
HTTP Header: 500 Internal Server Error
Content: ERR -20
