La forma mas sencilla de autenticación es usando tu nombre de usuario en el parámetro user y tu contraseña en el parámetro password.

Transcripción

1 Action API Aspectos generales Lleida.net dispone de notificaciones basada en eventos. La Action API permite acceder a los servicios de configuración de notificaciones de Lleida.net mediante peticiones HTTP (te recomendamos el uso del protocolo HTTPS). La URL de la API es: La forma mas sencilla de autenticación es usando tu nombre de usuario en el parámetro user y tu contraseña en el parámetro password. En los ejemplos de esta documentación se usa el símbolo {:name} para tu nombre de usuario y {:pass} para tu contraseña. Todas las operaciones requieren de los siguientes parámetros: user Nombre de usuario de la cuenta de Lleida.net. password La contraseña de usuario. request Tipo de petición. request_id Opcional. Identificador de la petición. Aunque sea opcional recomendamos su uso. Los parámetros de entrada pueden estar encapsulados dentro de un documento XML o JSON. Este documento debe seguir el formato definido en action.dtd ( Peticiones en formato XML GET HTTP/1.1 Accept: application/xml xml={:action_xml} Accept: application/xml Peticiones en formato JSON

2 GET HTTP/1.1 Accept: application/json json={:action_json} Accept: application/json Peticiones con variables Otra alternativa es enviar los parámetros como tuplas clave:valor. La respuesta se puede configurar tanto en formato XML como JSON. GET HTTP/1.1 Accept: application/json user={:name}&password={:pass}&... Accept: application/xml Al turrón! Formato de respuesta Todas las operaciones reciben como respuesta un documento XML o JSON, cuyo nodo raíz es el elemento response. Éste se compone de varios elementos comunes y siempre presentes en todas las operaciones, seguidos de otros elementos específicos para la operación que se ha invocado. Los elementos comunes del elemento response son los siguientes: code Es el código de estado informativo del éxito o error de la operación. status Es la descripción del código de estado. request Contiene un nombre identificativo de la operación que se ha invocado. Las respuestas cumplen con la especificación de la DTD action_response.dtd ( Códigos de estado

3 Status Descripción 200 Success 1400 Method not allowed 1401 Invalid request 1402 Invalid content 1404 Invalid XML 1405 Invalid JSON 1500 Unknown error 1501 Timeout error 1502 Connection error 1503 Service unavailable Status Descripción Eventos y Acciones Eventos Los eventos se agrupan por MO (Mobile Originated), por DR (Delivery Report), por PDF (Generación de certificados) y ALERT. Estos eventos son los responsables de lanzar la notificación que tenga configurada el usuario. Acciones ALERT Notificación de numero disponible. MO_SMS Al recibir un SMS. DR_SMS Al actualizar el estado de un acuse de recibo de un SMS. MO_MMS Al recibir un MMS. DR_MMS Al actualizar el estado de un acuse de recibo de un MMS. PDF_SMS Al finalizar de generar el PDF certificado de un SMS tanto enviado como recibido. PDF_MMS Al finalizar de generar el PDF certificado de un SMS tanto enviado como recibido. Existen multiples acciones disponibles para configurar las notificaciones. Cada acción tiene un solo parámetro obligatorio. La acción MAIL_CERT es la única acción con el parámetro opcional lang cuyo valor por defecto es Español - ES. CGI Tiene como parámetro una URL. MAIL Tiene como parámetro una dirección de correo electrónico. MAIL_CERT Tiene como parámetro una dirección de correo electrónico válida y opcionalmente el idioma del certificado. RESP_AUTO_MMS Tiene como parámetro el nombre de un objeto multimedia. RESP_AUTO_SMS Tiene como parámetro el texto que se enviara por SMS. REDIRECT Tiene como parámetro un número de teléfono. MULTIMEDIA_OBJECT Tiene como parámetro el nombre del objecto multimedia.

4 Parámetros de las acciones url Debe comenzar con http(s):// Dirección de correo electrónico valida. lang Idioma del certificado. text Texto del SMS como máximo 160 caracteres (un solo SMS). name_obj Nombre del objecto multimedia. number Numero donde se reenviara el SMS. La siguiente tabla muestra la relación entre las acciones y los eventos; y el tipo de parámetro que se puede configurar. ALERT MO_SMS DR_SMS MO_MMS DR_MMS PDF_SMS PDF_MMS CGI url url url url url url url MAIL MAIL_CERT lang lang MULTIMEDIA_OBJECT text text REDIRECT number RESP_AUTO_MMS name_obj name_obj RESP_AUTO_SMS text text ALERT MO_SMS DR_SMS MO_MMS DR_MMS PDF_SMS PDF_MMS Idioma validos para los certificado

5 Código AR CA DE EN ES EU FR GL IT NL Código Idioma Español (Argentina) Català Deutsch English Español Euskara Français Galego Italiano Netherlands Idioma Campos de la acción CGI A continuación se detallan los campos enviados por POST según el evento configurado. ALERT MO_SMS MO_MMS idalert destino estado fecha_estado rcode mcc mnc id_user fecha origen destino texto idmo data_coding esm_class udh fecha origen

6 DR_SMS DR_MMS PDF_SMS PDF_MMS destino idmms idacuse estado fecha_recepcion idsms fecha_envio origen destino texto idacuse estado fecha_recepcion idmms fecha_envio origen destino cert_type lang event mo mt mt_id src dst ref_tsa cert_type lang event mmso mmst mmst_id src dst ref_tsa Añadir notificación. GET HTTP/1.1

7 Parámetros user Nombre de usuario de la cuenta de Lleida.net. password Tu contraseña de usuario. request add_action. request_id Opcional. Identificador de la petición. Aunque sea opcional recomendamos su uso. number Número de teléfono o all. action Tipo de notificación. CGI Tiene como parámetro una URL. MAIL Tiene como parámetro una dirección de correo electrónico. MAIL_CERT Tiene como parámetro una dirección de correo electrónico válida y opcionalmente el idioma del certificado. RESP_AUTO_MMS Tiene como parámetro el nombre de un objeto multimedia. RESP_AUTO_SMS Tiene como parámetro el texto que se enviara por SMS. REDIRECT Tiene como parámetro un número de teléfono. MULTIMEDIA_OBJECT Tiene como parámetro el nombre del objecto multimedia. event Tipo de evento. ALERT Notificación de numero disponible. MO_SMS Al recibir un SMS. DR_SMS Al actualizar el estado de un acuse de recibo de un SMS. MO_MMS Al recibir un MMS. DR_MMS Al actualizar el estado de un acuse de recibo de un MMS. PDF_SMS Al finalizar de generar el PDF certificado de un SMS tanto enviado como recibido. PDF_MMS Al finalizar de generar el PDF certificado de un SMS tanto enviado como recibido. value Es la URL o texto o o número de la acción. Ejemplo de petición user={:name}&password={:pass}&request=add_action&number=all&action=cgi& event=mo_sms&value= Accept: application/xml Respuesta <?xml version="1.0" encoding="iso "?> <!DOCTYPE response SYSTEM "action_response.dtd"> <response> <request>add_action</request> <code>200</code> <status>success</status> <user> <id>391967</id> <name>{:name}</name> <credit>48.00</credit> <numbers>

8 <number> </number> <number> </number> <number> </number> <number> </number> <number> </number> </numbers> <actions> <total>2</total> <action> <id>25122</id> <event>mo_sms</event> <type>mail</type> <number>all</number> </action> <action> <id>25123</id> <event>mo_sms</event> <type>cgi</type> <value> <number>all</number> </action> </actions> </user> </response> Editar notificación. GET HTTP/1.1 Parámetros user Nombre de usuario de la cuenta de Lleida.net. password Tu contraseña de usuario. request edit_action. request_id Opcional. Identificador de la petición. Aunque sea opcional recomendamos su uso. action_id Identificar de la notificación. value Es la URL o texto o de la acción. Ejemplo de petición user={:name}&password={:pass}&request=edit_action&action_id=25123& value=

9 Accept: application/xml Respuesta <?xml version="1.0" encoding="iso "?> <!DOCTYPE response SYSTEM "action_response.dtd"> <response> <request>edit_action</request> <code>200</code> <status>success</status> <user> <id>391967</id> <name>{:name}</name> <credit>48.00</credit> <numbers> <number> </number> <number> </number> <number> </number> <number> </number> <number> </number> </numbers> <actions> <total>2</total> <action> <id>25122</id> <event>mo_sms</event> <type>mail</type> <number>all</number> </action> <action> <id>25123</id> <event>mo_sms</event> <type>cgi</type> <value> <number>all</number> </action> </actions> </user> </response> Eliminar notificación. GET HTTP/1.1

10 Parámetros user Nombre de usuario de la cuenta de Lleida.net. password Tu contraseña de usuario. request delete_action. request_id Opcional. Identificador de la petición. Aunque sea opcional recomendamos su uso. action_id Identificar de la notificación. Ejemplo de petición user={:name}&password={:pass}&request=delete_action&action_id=25123 Accept: application/xml Respuesta <?xml version="1.0" encoding="iso "?> <!DOCTYPE response SYSTEM "action_response.dtd"> <response> <request>delete_action</request> <code>200</code> <status>success</status> <user> <id>391967</id> <name>{:name}</name> <credit>48.00</credit> <numbers> <number> </number> <number> </number> <number> </number> <number> </number> <number> </number> </numbers> <actions> <total>1</total> <action> <id>25122</id> <event>mo_sms</event> <type>mail</type> <number>all</number> </action> </actions> </user> </response>

11 Consultar notificaciones. GET HTTP/1.1 Parámetros user Nombre de usuario de la cuenta de Lleida.net. password Tu contraseña de usuario. request info. request_id Opcional. Identificador de la petición. Aunque sea opcional recomendamos su uso. Ejemplo de petición user={:name}&password={:pass}&request=info Accept: application/xml Respuesta <?xml version="1.0" encoding="iso "?> <!DOCTYPE response SYSTEM "action_response.dtd"> <response> <request>info</request> <code>200</code> <status>success</status> <user> <id>391967</id> <name>z</name> <credit>48.00</credit> <numbers> <number> </number> <number> </number> <number> </number> <number> </number> <number> </number> </numbers> <actions> <total>1</total> <action> <id>25122</id> <event>mo_sms</event> <type>mail</type>

12 <number>all</number> </action> </actions> </user> </response>