Para poder utilizar SMSEagle para enviar o recibir mensajes desde cualquier aplicación o sistema externo que tenga, hemos proporcionado las siguientes funcionalidades de la API.

Si desea comenzar a utilizar la API de SMSEagle sin problemas y rápidamente, por favor, mire la página de muestras de código. Para una descripción aún más detallada consulte el último Manual de Usuario

Autenticación de la API

Antes de poder empezar a utilizar la API, primero debe habilitar el acceso a la API.

  1. Ir a Web-GUI > menú Usuarios
  2. Crear un nuevo usuario con nivel de acceso “Usuario”, establecer “Acceso a la API” en “Activado” (opcionalmente puede limitar el acceso solo a los métodos de la API seleccionados)
  3. Elija el método de autenticación de la API. Este puede ser cualquiera de los dos:
    • token de acceso (solución recomendada)
      Edita tu usuario de la API > marca “Habilitar token” y genera un nuevo token de acceso. El token se utilizará para autenticarse en los métodos de la API.
      o
    • nombre de usuario y contraseña
      Utilice sus credenciales de usuario de la API para autenticarse en los métodos de la API.

Ejemplos de autenticación:

  • con el token de acceso
    https://url-of-smseagle/http_api/send_sms?access_token=0001gOjCOlMH8F2q&to=1234567&message=mymessage
  • con el nombre de usuario y la contraseña
    https://url-of-smseagle/http_api/send_sms?login=john&pass=doe&to=1234567&message=mymessage

Las credenciales de la API creadas aquí se utilizarán para autenticar en todos los métodos de la API (vea las descripciones que figuran a continuación).

Enviar SMS: Método HTTP GET

Método GET HTTP: https://url-of-smseagle/index.php/http_api/send_sms

Ejemplos:
https://url-of-smseagle/index.php/http_api/send_sms?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&to=1234567&message=mymessage
o
https://url-of-smseagle/index.php/http_api/send_sms?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&to=1234567&message=mymessage&date=201401152132
o
https://url-of-smseagle/index.php/http_api/send_sms?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&to=1234567&message=mymessage&highpriority=1

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
to Número de teléfono del destinatario (o números separados por una coma)
message su mensaje SMS
date (parámetro opcional) fecha y hora en formato YYYYmmDDHHMM (YYYY – año, mm – mes, DD – día, HH – hora, MM – minuto). Si este parámetro no es nulo, se programará el envío de SMS en la fecha y hora indicadas
highpriority (parámetro opcional) 0 = prioridad normal, 1 = el SMS tendrá mayor prioridad en la Bandeja de Salida cuando sea procesado por el módem GSM/3G
unicode (parámetro opcional) 0 = sin codificación Unicode (por defecto), 1 = el SMS será codificado usando Unicode (puede enviar caracteres nacionales)
flash (parámetro opcional) 0 = SMS normal (por defecto), 1 = SMS será enviado como mensaje flash
oid (parámetro opcional) Este atributo especifica un ID único definido por el usuario que se asigna a un par de receptores de mensajes. El oid es un varchar(36) que identifica de manera única un mensaje enviado a un destinatario particular (número de teléfono particular).
El valor de esta ID permite a las aplicaciones para el cliente hacer coincidir los mensajes de respuesta entrantes con los mensajes salientes. Si no se asignó un oid al mensaje saliente este atributo tendrá un valor de null para el mensaje entrante. El valor oid se asignará automáticamente al mensaje entrante sólo si el número de teléfono entrante coincide exactamente con el número de teléfono (incluido el código de país) del mensaje saliente.
modem_no (parámetro opcional) número de módem de envío (solo para dispositivos multimodales)
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML
validity (parámetro opcional) Cuánto tiempo será válido el mensaje. Si el mensaje expira antes de ser recibido por un teléfono, el mensaje será descartado por la red celular. Valores de parámetros aceptables: 5m, 10m, 30m, 1h, 2h, 4h, 12h, 1d, 2d, 5d, 1w, 2w, 4w, máximo. Valor por defecto: max
send_after (parámetro opcional) enviar un mensaje después de un tiempo especificado. Puede utilizarse para
evitar que se envíen mensajes por la noche. Formato: HH:MM:SS (HH – hora, MM – minuto, SS – segundo)
send_before (parámetro opcional) enviar un mensaje antes de un tiempo especificado. Puede utilizarse para
evitar que se envíen mensajes por la noche. Formato: HH:MM:SS (HH – hora, MM – minuto, SS – segundo)

Respuesta:
Respuesta: OK; ID=[ID of message in outbox]
Muestra de respuesta: OK; ID=297
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos): Wrong parameters

Respuesta (XML):
Respuesta:
<xml>
<message_id>[ID of message in outbox]</message_id>
<status>ok</status>
</xml>

Muestra de respuesta:
<xml>
<message_id>297</message_id>
<status>ok</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text>Wrong parameters</error_text>
<status>error</status>
</xml>

Aviso importante: Debes codificar la URL antes de enviarla al gateway si utilizas caracteres nacionales en el texto del mensaje SMS.

Enviar un SMS: Método JSONRPC

Método de llamada POST HTTP: https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”sms.send_sms”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”to”:”481234567″,”message”:”My message”}}
o
{“method”:”sms.send_sms”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”to”:”481234567″,”message”:”My message”,”date”:”201401152132″}}
o
{“method”:”sms.send_sms”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”to”:”481234567″,”message”:”My message”,”highpriority”:”1″}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
to número de teléfono del destinatario (o números separados por una coma)
message su mensaje SMS
date (parámetro opcional) fecha y hora en formato YYYYmmDDHHMM (YYYY – año, mm – mes, DD – día, HH – hora, MM – minuto). Si este parámetro no es nulo, se programará el envío de SMS en la fecha y hora indicadas
highpriority (parámetro opcional) 0 = prioridad normal, 1 = el SMS tendrá mayor prioridad en la Bandeja de Salida cuando sea procesado por el módem GSM/3G
unicode (parámetro opcional) 0 = sin codificación Unicode (por defecto), 1 = el SMS será codificado usando Unicode (puede enviar caracteres nacionales)
flash (parámetro opcional) 0 = SMS normal (por defecto), 1 = SMS será enviado como mensaje flash
oid (parámetro opcional) Este atributo especifica un ID único definido por el usuario que se asigna a un par de receptores de mensajes. El oid es un varchar(36) que identifica de manera única un mensaje enviado a un destinatario particular (número de teléfono particular).
El valor de esta ID permite a las aplicaciones para el cliente hacer coincidir los mensajes de respuesta entrantes con los mensajes salientes. Si no se asignó un oid al mensaje saliente este atributo tendrá un valor de null para el mensaje entrante. El valor oid se asignará automáticamente al mensaje entrante sólo si el número de teléfono entrante coincide exactamente con el número de teléfono (incluido el código de país) del mensaje saliente.
modem_no (parámetro opcional) número de módem de envío (solo para dispositivos multimodales)
responsetype (parámetro opcional) simple = formato de respuesta como objeto simple con un campo de resultado (por defecto), extendido = formato de respuesta como objeto JSON extendido
validity (parámetro opcional) Cuánto tiempo será válido el mensaje. Si el mensaje expira antes de ser recibido por un teléfono, el mensaje será descartado por la red celular. Valores de parámetros aceptables: 5m, 10m, 30m, 1h, 2h, 4h, 12h, 1d, 2d, 5d, 1w, 2w, 4w, máximo. Valor por defecto: max
send_after (parámetro opcional) enviar un mensaje después de un tiempo especificado. Puede utilizarse para
evitar que se envíen mensajes por la noche. Formato: HH:MM:SS (HH – hora, MM – minuto, SS – segundo)
send_before (parámetro opcional) enviar un mensaje antes de un tiempo especificado. Puede utilizarse para
evitar que se envíen mensajes por la noche. Formato: HH:MM:SS (HH – hora, MM – minuto, SS – segundo)
Respuesta:
Respuesta: {“result”: “OK; ID=[ID of message in outbox]”}
Muestra de respuesta: {“result”: “OK; ID=297”}
Respuesta: {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”: “Invalid access token”}
Respuesta: {“result”: “Wrong parameters”}
Respuesta (ampliada):
Respuesta:{“result”:{“message_id”:”[ID ofmessage in outbox]”,”status”:”ok”}}
Muestra de respuesta:{“result”:{“message_id”:”748″,”status”:”ok”}}
Muestra de respuesta cuando el parámetro “a” contiene varios números de teléfono:
{“result”:[{“message_id”:”3643″,”status”:”ok”},{“message_id”:”3644″,”status”:”ok”},{“message_id”:”3645″,”status”:”ok”},{“message_id”:”3646″,”status”:”ok”},{“message_id”:”3647″,”status”:”ok”}]}
Respuesta(cuando los datos de acceso son incorrectos):{“result”:{“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando los parámetros son incorrectos):{“result”:{“error_text”:”Wrong parameters”,”status”:”error”}}

Important Notice: You must encode URL before sending it to gateway if
you use any special characters in SMS message text.

Enviar un SMS a un grupo: Método HTTP GET

Método GET HTTP: https://url-of-smseagle/index.php/http_api/send_togroup

Ejemplos:
https://url-of-smseagle/index.php/http_api/send_togroup?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&groupname=admins&message=mymessage
o
https://url-of-smseagle/index.php/http_api/send_togroup?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&groupname=admins&message=mymessage&date=201401152132
o
https://url-of-smseagle/index.php/http_api/send_togroup?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&groupname=admins&message=mymessage&highpriority=1

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
groupname nombre de grupo definido en su Directorio Telefónico SMSEagle. El grupo debe ser definido como Público
message su mensaje SMS
date (parámetro opcional) fecha y hora en formato YYYYmmDDHHMM (YYYY – año, mm – mes, DD – día, HH – hora, MM – minuto). Si este parámetro no es nulo, se programará el envío de SMS en la fecha y hora indicadas
highpriority (parámetro opcional) 0 = prioridad normal, 1 = el SMS tendrá mayor prioridad en la Bandeja de Salida cuando sea procesado por el módem GSM/3G
unicode (parámetro opcional) 0 = sin codificación Unicode (por defecto), 1 = el SMS será codificado usando Unicode (puede enviar caracteres nacionales)
flash (parámetro opcional) 0 = SMS normal (por defecto), 1 = SMS será enviado como mensaje flash
modem_no (parámetro opcional) número de módem de envío (solo para dispositivos multimodales)
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML
validity (parámetro opcional) Cuánto tiempo será válido el mensaje. Si el mensaje expira antes de ser recibido por un teléfono, el mensaje será descartado por la red celular. Valores de parámetros aceptables: 5m, 10m, 30m, 1h, 2h, 4h, 12h, 1d, 2d, 5d, 1w, 2w, 4w, máximo. Valor por defecto: max
send_after (parámetro opcional) enviar un mensaje después de un tiempo especificado. Puede utilizarse para
evitar que se envíen mensajes por la noche. Formato: HH:MM:SS (HH – hora, MM – minuto, SS – segundo)
send_before (parámetro opcional) enviar un mensaje antes de un tiempo especificado. Puede utilizarse para
evitar que se envíen mensajes por la noche. Formato: HH:MM:SS (HH – hora, MM – minuto, SS – segundo)
Respuesta:
Respuesta: OK; ID=[ID of message in outbox]
Muestra de respuesta: OK; ID=297
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos): Wrong parameters
Respuesta (XML):

Respuesta:
<xml>
<message_id>[ID of message in outbox]</message_id>
<status>ok</status>
</xml>

Muestra de respuesta:
<xml>
<message_id>297</message_id>
<status>ok</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text>Wrong parameters</error_text>
<status>error</status>
</xml>

Aviso importante: Debes codificar la URL antes de enviarla al gateway si utilizas caracteres nacionales en el texto del mensaje SMS.

Enviar un SMS a un grupo: Método JSONRPC

Método POST HTTP: https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”sms.send_togroup”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”groupname”:”admins”,”message”:”mymessage”}}
o
{“method”:”sms.send_togroup”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”groupname”:”admins”,”message”:”mymessage”,”date”:”201401152132″}}
o
{“method”:”sms.send_togroup”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”groupname”:”admins”,”message”:”mymessage”,”highpriority”:”1″}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
groupname nombre de grupo definido en su Directorio Telefónico SMSEagle. El grupo debe ser definido como Público
message su mensaje SMS
date (parámetro opcional) fecha y hora en formato YYYYmmDDHHMM (YYYY – año, mm – mes, DD – día, HH – hora, MM – minuto). Si este parámetro no es nulo, se programará el envío de SMS en la fecha y hora indicadas
highpriority (parámetro opcional) 0 = prioridad normal, 1 = el SMS tendrá mayor prioridad en la Bandeja de Salida cuando sea procesado por el módem GSM/3G
unicode (parámetro opcional) 0 = sin codificación Unicode (por defecto), 1 = el SMS será codificado usando Unicode (puede enviar caracteres nacionales)
flash (parámetro opcional) 0 = SMS normal (por defecto), 1 = SMS será enviado como mensaje flash
modem_no (parámetro opcional) número de módem de envío (solo para dispositivos multimodales)
responsetype (parámetro opcional) simple = formato de respuesta como objeto simple con un campo de resultado (por defecto), extendido = formato de respuesta como objeto JSON extendido
validity (parámetro opcional) Cuánto tiempo será válido el mensaje. Si el mensaje expira antes de ser recibido por un teléfono, el mensaje será descartado por la red celular. Valores de parámetros aceptables: 5m, 10m, 30m, 1h, 2h, 4h, 12h, 1d, 2d, 5d, 1w, 2w, 4w, máximo. Valor por defecto: max
send_after (parámetro opcional) enviar un mensaje después de un tiempo especificado. Puede utilizarse para
evitar que se envíen mensajes por la noche. Formato: HH:MM:SS (HH – hora, MM – minuto, SS – segundo)
send_before (parámetro opcional) enviar un mensaje antes de un tiempo especificado. Puede utilizarse para
evitar que se envíen mensajes por la noche. Formato: HH:MM:SS (HH – hora, MM – minuto, SS – segundo)
Respuesta:
Respuesta: {“result”: “OK; ID=[ID of message in outbox]”}
Muestra de respuesta: {“result”: “OK; ID=[297]”}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”: “Invalid access token”}
Respuesta (cuando los parámetros son incorrectos): {“result”: “Wrong parameters”}
Respuesta (Ampliada):
Respuesta: {“result”:{“message_id”:”[ID of message in outbox]”,”status”:”ok”}}
Muestra de respuesta: {“result”:{“message_id”:”748″,”status”:”ok”}}
Respuesta (cuando los datos de acceso son incorrectos): {“result”:{“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (cuando los parámetros son incorrectos):{“result”:{“error_text”:”Wrong parameters”,”status”:”error”}}


Aviso importante: Debes codificar la URL antes de enviarla al gateway la puerta de enlace si utilizas caracteres nacionales en el texto del mensaje SMS.

Enviar un SMS a un contacto: Método HTTP GET

Método GET HTTP: https://url-of-smseagle/index.php/http_api/send_tocontact

Ejemplos:
https://url-of-smseagle/index.php/http_api/send_tocontact?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&contactname=johndoe&message=mymessage
o
https://url-of-smseagle/index.php/http_api/send_tocontact?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&contactname=johndoe&message=mymessage&date=201401152132
o
https://url-of-smseagle/index.php/http_api/send_tocontact?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&contactname=johndoe&message=mymessage&highpriority=1

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
contactname contact name (or names separated by comma) defined in your SMSEagle Phonebook . Contacts must be defined as Public
message su mensaje SMS
date (parámetro opcional) fecha y hora en formato YYYYmmDDHHMM (YYYY – año, mm – mes, DD – día, HH – hora, MM – minuto). Si este parámetro no es nulo, se programará el envío de SMS en la fecha y hora indicadas
highpriority (parámetro opcional) 0 = prioridad normal, 1 = el SMS tendrá mayor prioridad en la Bandeja de Salida cuando sea procesado por el módem GSM/3G
unicode (parámetro opcional) 0 = sin codificación Unicode (por defecto), 1 = el SMS será codificado usando Unicode (puede enviar caracteres nacionales)
flash (parámetro opcional) 0 = SMS normal (por defecto), 1 = SMS será enviado como mensaje flash
modem_no (parámetro opcional) número de módem de envío (solo para dispositivos multimodales)
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML
validity (parámetro opcional) Cuánto tiempo será válido el mensaje. Si el mensaje expira antes de ser recibido por un teléfono, el mensaje será descartado por la red celular. Valores de parámetros aceptables: 5m, 10m, 30m, 1h, 2h, 4h, 12h, 1d, 2d, 5d, 1w, 2w, 4w, máximo. Valor por defecto: max
send_after (parámetro opcional) enviar un mensaje después de un tiempo especificado. Puede utilizarse para
evitar que se envíen mensajes por la noche. Formato: HH:MM:SS (HH – hora, MM – minuto, SS – segundo)
send_before (parámetro opcional) enviar un mensaje antes de un tiempo especificado. Puede utilizarse para
evitar que se envíen mensajes por la noche. Formato: HH:MM:SS (HH – hora, MM – minuto, SS – segundo)
Respuesta:
Respuesta: OK; ID=[ID of message in outbox]
Muestra de respuesta: OK; ID=297
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando el contacto no existe): Invalid contact name – [contact_name]
Respuesta (cuando los parámetros son incorrectos): Wrong parameters
Respuesta (XML):

Respuesta:
<xml>
<message_id>[ID of message in outbox]</message_id>
<status>ok</status>
</xml>

Muestra de respuesta:
<xml>
<message_id>297</message_id>
<status>ok</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando el contacto no existe):
<xml>
<error_text>Invalid contact name – [contact_name]</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text>Wrong parameters</error_text>
<status>error</status>
</xml>

Aviso importante: Debes codificar la URL antes de enviarla al gateway si utilizas caracteres nacionales en el texto del mensaje SMS.

Enviar un SMS a un contacto: Método JSONRPC

Método POST HTTP: https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”sms.send_tocontact”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”contactname”:”johndoe”,”message”:”mymessage”}}
o
{“method”:”sms.send_tocontact”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”contactname”:”johndoe”,”message”:”mymessage”,”date”:”201401152132″}}
o
{“method”:”sms.send_tocontact”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”contactname”:”admins”,”message”:”mymessage”,”highpriority”:”1″}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
contactname contact name defined in your SMSEagle Phonebook. The contact must be defined as Public
message su mensaje SMS
date (parámetro opcional) fecha y hora en formato YYYYmmDDHHMM (YYYY – año, mm – mes, DD – día, HH – hora, MM – minuto). Si este parámetro no es nulo, se programará el envío de SMS en la fecha y hora indicadas
highpriority (parámetro opcional) 0 = prioridad normal, 1 = el SMS tendrá mayor prioridad en la Bandeja de Salida cuando sea procesado por el módem GSM/3G
unicode (parámetro opcional) 0 = sin codificación Unicode (por defecto), 1 = el SMS será codificado usando Unicode (puede enviar caracteres nacionales)
flash (parámetro opcional) 0 = SMS normal (por defecto), 1 = SMS será enviado como mensaje flash
modem_no (parámetro opcional) número de módem de envío (solo para dispositivos multimodales)
responsetype (parámetro opcional) simple = formato de respuesta como objeto simple con un campo de resultado (por defecto), extendido = formato de respuesta como objeto JSON extendido
validity (parámetro opcional) Cuánto tiempo será válido el mensaje. Si el mensaje expira antes de ser recibido por un teléfono, el mensaje será descartado por la red celular. Valores de parámetros aceptables: 5m, 10m, 30m, 1h, 2h, 4h, 12h, 1d, 2d, 5d, 1w, 2w, 4w, máximo. Valor por defecto: max
send_after (parámetro opcional) enviar un mensaje después de un tiempo especificado. Puede utilizarse para
evitar que se envíen mensajes por la noche. Formato: HH:MM:SS (HH – hora, MM – minuto, SS – segundo)
send_before (parámetro opcional) enviar un mensaje antes de un tiempo especificado. Puede utilizarse para
evitar que se envíen mensajes por la noche. Formato: HH:MM:SS (HH – hora, MM – minuto, SS – segundo)
Respuesta:
Respuesta: {“result”: “OK; ID=[ID of message in outbox]”}
Muestra de respuesta: {“result”: “OK; ID=[297]”}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”: “Invalid access token”}
Respuesta (cuando el contacto no existe): {“result”: “Invalid contact name – contact_name]”}
Respuesta (cuando los parámetros son incorrectos): {“result”: “Wrong parameters”}
Respuesta (Ampliada):
Respuesta: {“result”:{“message_id”:”[ID of message in outbox]”,”status”:”ok”}}
Muestra de respuesta: {“result”:{“message_id”:”748″,”status”:”ok”}}
Respuesta (cuando los datos de acceso son incorrectos): {“result”:{“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (cuando el contacto no existe): {“result”: {“error_text”:”Invalid contact name – contact_name]”,”status”:”error”}}
Respuesta (cuando los parámetros son incorrectos):{“result”:{“error_text”:”Wrong parameters”,”status”:”error”}}


Aviso importante: Debes codificar la URL antes de enviarla al gateway si utilizas caracteres nacionales en el texto del mensaje SMS.

Enviar SMS binario: Método HTTP GET

Método GET HTTP: https://url-of-smseagle/index.php/http_api/send_binary_sms

Ejemplo:
https://url-of-smseagle/index.php/http_api/send_binary_sms?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&to=1234567&udh=0605040B8423F0&data=EA0601AE02056A0045C60C037777772E736D736561676C652E657500080103534D534561676C65000101

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
to recipient telephone number (or numbers separated with comma)
udh (parámetro opcional) Encabezado UDH para el mensaje (en formato hexadecimal)
data mensaje binario (en formato hexadecimal)
class (parámetro opcional) clase de mensaje
modem_no (parámetro opcional) número de módem de envío (solo para dispositivos multimodales)
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML
Respuesta:
Respuesta: OK; ID=[ID of message in outbox]
Muestra de respuesta: OK; ID=297
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos): Wrong or missing >>udh<< parameter
Respuesta (cuando los parámetros son incorrectos): Wrong or missing >>data<< parameter

Respuesta (XML):
Respuesta:
<xml>
<message_id>[ID of message in outbox]</message_id>
<status>ok</status>
</xml>

Muestra de respuesta:
<xml>
<message_id>297</message_id>
<status>ok</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text> Wrong or missing >>udh<< parameter </error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text> Wrong or missing >>data<< parameter </error_text>
<status>error</status>
</xml>

Enviar un SMS binario: Método JSONRPC

Método POST HTTP: https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”sms.send_binary_sms”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”to”:”1234567″,”udh”:”0605040B8423F0″,”data”:”EA0601AE02056A0045C60C037777772E736D736561676C652E657500080103534D534561676C65000101″}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
to recipient telephone number (or numbers separated with comma)
udh (parámetro opcional) Encabezado UDH para el mensaje (en formato hexadecimal)
data mensaje binario (en formato hexadecimal)
class (parámetro opcional) clase de mensaje
modem_no (parámetro opcional) número de módem de envío (solo para dispositivos multimodales)
responsetype (parámetro opcional) simple = formato de respuesta como objeto simple con un campo de resultado (por defecto), extendido = formato de respuesta como objeto JSON extendido
Respuesta:
Respuesta: {“result”: “OK; ID=[ID of message in outbox]”}
Muestra de respuesta: {“result”: “OK; ID=297”}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”: “Invalid access token”}
Respuesta (cuando los parámetros son incorrectos): {“result”: “Wrong or missing >>udh<< parameter”}
Respuesta (cuando los parámetros son incorrectos): {“result”: “Wrong or missing >>data<< parameter”}
Respuesta (Ampliada):
Respuesta: {“result”:{“message_id”:”[ID of message in outbox]”,”status”:”ok”}}
Muestra de respuesta: {“result”:{“message_id”:”748″,”status”:”ok”}}
Respuesta (cuando los datos de acceso son incorrectos): {“result”:{“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (cuando los parámetros son incorrectos):{“result”:{“error_text”:”Wrong or missing>>udh<< parameter”,”status”:”error”}}
Respuesta (cuando los parámetros son incorrectos):{“result”:{“error_text”:”Wrong or missing >>data<< parameter”,”status”:”error”}}

Enviar el código USSD: Método HTTP GET

Método GET HTTP: https://url-of-smseagle/index.php/http_api/send_ussd

Ejemplo:
https://url-of-smseagle/index.php/http_api/send_ussd?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&to=%2A101%23

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
to USSD code (urlencoded)
modem_no (parámetro opcional) número de módem de envío (solo para dispositivos multimodales)
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML
Respuesta:
Respuesta: OK; ID=[ID of message in outbox]
Muestra de respuesta: OK; ID=297
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos): Wrong parameters

Respuesta (XML):
Respuesta:
<xml>
<message_id>[ID of message in outbox]</message_id>
<status>ok</status>
</xml>

Muestra de respuesta:
<xml>
<message_id>297</message_id>
<status>ok</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text> Wrong parameters </error_text>
<status>error</status>
</xml>

Aviso importante: La respuesta de la red GSM/3G aparecerá en la carpeta de la bandeja de entrada.

Enviar el código USSD: Método JSONRPC

Método POST HTTP: https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”sms.send_ussd”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”to”:”*101#”}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
to Código USSD
modem_no (parámetro opcional) número de módem de envío (solo para dispositivos multimodales)
responsetype (parámetro opcional) simple = formato de respuesta como objeto simple con un campo de resultado (por defecto), extendido = formato de respuesta como objeto JSON extendido
Respuesta:
Respuesta: {“result”: “OK; ID=[ID of message in outbox]”}
Muestra de respuesta: {“result”: “OK; ID=297”}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”: “Invalid access token”}
Respuesta (cuando los parámetros son incorrectos): {“result”: “Wrong parameters”}
Respuesta (Ampliada):
Respuesta:
{“result”:{“message_id”:”[ID of message in outbox]”,”status”:”ok”}}
Muestra de respuesta: {“result”:{“message_id”:”748″,”status”:”ok”}}
Respuesta (cuando los datos de acceso son incorrectos): {“result”:{“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (cuando los parámetros son incorrectos):{“result”:{“error_text”:”Wrong parameters”,”status”:”error”}}
Aviso importante: La respuesta de la red GSM/3G aparecerá en la carpeta de la bandeja de entrada.

Leer SMS: Método HTTP GET

Método GET HTTP: https://url-of-smseagle/index.php/http_api/read_sms

Ejemplos:
Mostrar todos los mensajes de la bandeja de entrada:
https://url-of-smseagle/index.php/http_api/read_sms?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&folder=inbox

Mostrar todos los mensajes no leídos de la bandeja de entrada:
https://url-of-smseagle/index.php/http_api/read_sms?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&folder=inbox&unread=1

Mostrar mensajes de la carpeta de elementos enviados con id=1234 a 1236:
https://url-of-smseagle/index.php/http_api/read_sms?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&folder=sentitems&idfrom=1234&idto=1236

Mostrar mensajes de la carpeta de entrada con el número de teléfono del remitente +481234567:
https://url-of-smseagle/index.php/http_api/read_sms?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&folder=inbox&from=+481234567

Mostrar mensajes de la carpeta de elementos enviados con el número de teléfono del receptor 7654321 y la fecha y hora de 2014-12-24 08:10:00 a 2014-12-31 23:59:59:
https://url-of-smseagle/index.php/http_api/read_sms?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&folder=sentitems&to=7654321&datefrom=20141224081000&dateto=20141231235959

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
folder uno de los siguientes: bandeja de entrada, bandeja de salida, ítems enviados
idfrom (parámetro opcional) mensaje-id mínimo
idto (parámetro opcional) mensaje-id máximo
from (parámetro opcional) número de teléfono del remitente del SMS (para la bandeja de entrada)
to (parámetro opcional) número de teléfono del receptor de SMS (para los ítems enviados)
datefrom (parámetro opcional) fecha y hora en formato YYYYmmDDHHMMSS (YYYY – año, mm – mes, DD – día, HH – hora, MM – minutos, SS – segundos). Mostrar sólo los mensajes enviados/recibidos en esta fecha/hora y más adelante
dateto (parámetro opcional) fecha y hora en formato YYYYmmDDHHMMSS (YYYY – año, mm – mes, DD – día, HH – hora, MM – minutos, SS – segundos). Mostrar sólo los mensajes enviados/recibidos en esta fecha/hora y antes
limit (parámetro opcional) cuántos mensajes mostrar
unread (parámetro opcional) 1 = mostrar sólo los mensajes no leídos
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML
createdby (parámetro opcional) nombre de usuario o email (si el mensaje fue enviado por email a SMS) del usuario remitente
modem_no (parámetro opcional) número de módem de envío (solo para dispositivos multimodales)

Respuesta:
Muestra de respuestas: inbox folder, sentitems folder
Respuesta (cuando no hay datos): No data to display
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos): Wrong parameters

Respuesta (XML):
Muestra de respuesta: inbox folder, sentitems folder

Respuesta (cuando no hay datos):
<xml>
<error_text>No data to display</error_text>
<status>error</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text>Wrong parameters</error_text>
<status>error</status>
</xml>

Leer SMS: Método JSONRPC

Método POST HTTP: https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
Mostrar todos los mensajes de la bandeja de entrada:
{“method”:”sms.read_sms”,”params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”folder”:”inbox”}}

Mostrar todos los mensajes no leídos de la bandeja de entrada:
{“method”:”sms.read_sms”,”params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”folder”:”inbox”,”unread”:”1″}}

Mostrar mensajes de la carpeta de elementos enviados con id=1234 a 1236:
{“method”:”sms.read_sms”,”params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”folder”:”sentitems”,”idfrom”:”1234″,”idto”:”1236″}}

Mostrar mensajes de la carpeta de entrada con el número de teléfono del remitente +481234567:
{“method”:”sms.read_sms”,”params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”folder”:”inbox”,”from”:”481234567″}}

Mostrar mensajes de la carpeta de elementos enviados con el número de teléfono del receptor 7654321 y la fecha y hora de 2014-12-24 08:10:00 a 2014-12-31 23:59:59:
{“method”:”sms.read_sms”,”params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”folder”:”sentitems”,”to”:”7654321″,”datefrom”:”20141224081000″,”dateto”:”20141231235959″}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
folder uno de los siguientes: bandeja de entrada, bandeja de salida, ítems enviados
idfrom (parámetro opcional) mensaje-id mínimo
idto (parámetro opcional) mensaje-id máximo
from (parámetro opcional) número de teléfono del remitente del SMS (para la bandeja de entrada)
to (parámetro opcional) número de teléfono del receptor de SMS (para los ítems enviados)
datefrom (parámetro opcional) fecha y hora en formato YYYYmmDDHHMMSS (YYYY – año, mm – mes, DD – día, HH – hora, MM – minutos, SS – segundos). Mostrar sólo los mensajes enviados/recibidos en esta fecha/hora y más adelante
dateto (parámetro opcional) fecha y hora en formato YYYYmmDDHHMMSS (YYYY – año, mm – mes, DD – día, HH – hora, MM – minutos, SS – segundos). Mostrar sólo los mensajes enviados/recibidos en esta fecha/hora y antes
limit (parámetro opcional) cuántos mensajes mostrar
unread (parámetro opcional) 1 = mostrar sólo los mensajes no leídos
custom (parámetro opcional) nombre de Mi Carpeta (carpeta personalizada definida en Web-GUI) para leer de
responsetype (parámetro opcional) simple = formato de respuesta como objeto simple con un campo de resultado (por defecto), extendido = formato de respuesta como objeto JSON extendido
createdby (parámetro opcional) nombre de usuario o email (si el mensaje fue enviado por email a SMS) del usuario remitente
modem_no (parámetro opcional) número de módem de envío (solo para dispositivos multimodales)
Respuesta:
Muestra de respuesta: inbox folder, sentitems folder
Respuesta (cuando no hay datos): {“result”: “No data to display”}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”:”Invalid access token”}
Respuesta (cuando los parámetros son incorrectos): {“result”: “Wrong parameters”}
Respuesta (Ampliada):
Muestra de respuesta: inbox folder, sentitems folder
Respuesta (cuando no hay datos): {“result”:{“error_text”:”No data to display”,”status”:”error”}}
Respuesta(cuando los datos de acceso son incorrectos): {“result”:{“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (cuando los parámetros son incorrectos): {“result”:{“error_text”:”Wrong or missing >>udh<< parameter”,”status”:”error”}}

Borrar SMS: Método HTTP GET

Método GET HTTP: https://url-of-smseagle/index.php/http_api/delete_sms

Ejemplos:
Borrar el mensaje con id=1234 de la bandeja de entrada:
http://url-of-smseagle/index.php/http_api/delete_sms?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&folder=inbox&idfrom=1234&idto=1234

Delete messages with id 1234 – 1250 from inbox:
http://url-of-smseagle/index.php/http_api/delete_sms?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&folder=inbox&idfrom=1234&idto=1250

Borrar todos los mensajes de la bandeja de salida:
http://url-of-smseagle/index.php/http_api/delete_sms?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&folder=outbox&idfrom=1&idto=999999999

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
folder uno de los siguientes: bandeja de entrada, bandeja de salida, ítems enviados
idfrom mínimo de id del mensaje
idto máximo de id del mensaje
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML

Respuesta:
Respuesta: OK
Respuesta (cuando la operación de borrado no tuvo éxito): Error
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token

Respuesta (XML):
Respuesta:
<xml>
<status>ok</status>
</xml>

Respuesta (cuando la operación de borrado no tuvo éxito):
<xml>
<status>error</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Borrar SMS: Método JSONRPC

Método POST HTTP: https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
Borrar el mensaje con id=1234 de la bandeja de entrada:
{“method”:”sms.delete_sms”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”folder”:”inbox”,”idfrom”:”1234″”idto”:”1234″}}

Borrar los mensajes con id 1234 – 1250 de la bandeja de entrada:
{“method”:”sms.delete_sms”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”folder”:”inbox”,”idfrom”:”1234″,”idto”:”1250″}}

Borrar todos los mensajes de la bandeja de salida:
{“method”:”sms.delete_sms”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”folder”:”outbox”,”idfrom”:”1″,”idto”:”999999999″}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
folder uno de los siguientes: bandeja de entrada, bandeja de salida, ítems enviados
idfrom mínimo de id del mensaje
idto máximo de id del mensaje
responsetype (parámetro opcional) simple = formato de respuesta como objeto simple con un campo de resultado (por defecto), extendido = formato de respuesta como objeto JSON extendido

Respuesta:
Respuesta: {“result”: “OK”}
Respuesta (cuando la operación de borrado no tuvo éxito): {“result”: “Error”}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”: “Invalid access token”}

Respuesta (Ampliada):
Respuesta: {“result”:{“status”:”ok”}}
Respuesta (cuando la operación de borrado no tuvo éxito): {“result”:{“status”:”error”}}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}

Obtener la longitud de la bandeja de salida: Método HTTP GET

Método GET HTTP: https://url-of-smseagle/index.php/http_api/get_queue_length

Ejemplo:
https://url-of-smseagle/index.php/http_api/get_queue_length?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML

Respuesta:
Respuesta: [number of messages in database that wait to be processed by GSM/3G-modem]
Muestra de respuesta: 7
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos): Wrong parameters

Respuesta (XML):
Respuesta:
<xml>
<queue_length>
[number of messages in database that wait to be processed by GSM/3G-modem]
</queue_length >
<status>ok</status>
</xml>

Muestra de respuesta:
<xml>
<queue_length>7</queue_length >
<status>ok</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text>Wrong parameters</error_text>
<status>error</status>
</xml>

Obtener la longitud de la bandeja de salida: Método JSONRPC

Método de llamada POST HTTP: https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”sms.get_queue_length”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
responsetype (parámetro opcional) simple = formato de respuesta como objeto simple con un campo de resultado (por defecto), extendido = formato de respuesta como objeto JSON extendido

Respuesta:
Respuesta: {“result”: [number of messages in database that wait to be processed by GSM/3G-modem]}
Muestra de respuesta: {“result”:7}
Respuesta: {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”: “Invalid access token”}
Respuesta: {“result”: “Wrong parameters”}

Respuesta (Ampliada):
Respuesta: {“result”:{“queue_length”:[number of messages in database that wait to be processed by GSM/3G-modem],”status”:”ok”}}
Muestra de respuesta: {“result”: {“queue_length”:”419″,”status”:”ok”}}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (cuando los parámetros son incorrectos): {“result”: {“error_text”:”Wrong parameters”,”status”:”error”}}

Obtener la longitud de la bandeja de entrada: Método HTTP GET

Método GET HTTP: https://url-of-smseagle/index.php/http_api/get_inbox_length

Ejemplo:

https://url-of-smseagle/index.php/http_api/get_inbox_length?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML
Respuesta:
Respuesta: [number of messages in database Inbox folder]
Muestra de respuesta: 3
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos): Wrong parameters
Respuesta (XML):

Respuesta:
<xml>
<queue_length>
[number of messages in database Inbox folder]
</queue_length>
<status>ok</status>
</xml>

Muestra de respuesta:
<xml>
<inbox_length>3</inbox_length>
<status>ok</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text>Wrong parameters</error_text>
<status>error</status>
</xml>

Obtener la longitud de la bandeja de entrada: Método JSONRPC

Método POST HTTP: https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”sms.get_inbox_length”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
responsetype (parámetro opcional) simple = formato de respuesta como objeto simple con un campo de resultado (por defecto), extendido = formato de respuesta como objeto JSON extendido
Respuesta:
Respuesta: {“result”: “[number of messages in database Inbox folder]”}
Muestra de respuesta: 3
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”: “Invalid access token”}
Respuesta (cuando los parámetros son incorrectos): {“result”: “Wrong parameters”}
Respuesta (Ampliada):
Respuesta: {“result”:{“inbox_length”:[number of messages in database Inbox folder],”status”:”ok”}}
Muestra de respuesta: {“result”: {“inbox_length”:”3″,”status”:”ok”}}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (cuando los parámetros son incorrectos): {“result”: {“error_text”:”Wrong parameters”,”status”:”error”}}

Obtener la longitud de los elementos enviados: Método HTTP GET

Método GET HTTP: https://url-of-smseagle/index.php/http_api/get_sentitems_length

Ejemplo:
https://url-of-smseagle/index.php/http_api/get_sentitems_length?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML
Respuesta:
Respuesta: [number of messages in database Sentitems folder]
Muestra de respuesta: 21
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos): Wrong parameters

Respuesta (XML):
Respuesta:
<xml>
<sentitems_length>
[number of messages in database Inbox folder]
</sentitems_length>
<status>ok</status>
</xml>

Muestra de respuesta:
<xml>
<sentitems_length>21</sentitems_length>
<status>ok</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text>Wrong parameters</error_text>
<status>error</status>
</xml>

Obtener la longitud de los elementos enviados: Método JSONRPC

Método POST HTTP: https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”sms.get_sentitems_length”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
responsetype (parámetro opcional) simple = formato de respuesta como objeto simple con un campo de resultado (por defecto), extendido = formato de respuesta como objeto JSON extendido
Respuesta:
Respuesta: {“result”: “[number of messages in database Sentitems folder]”}
Muestra de respuesta: {“result”: “21”}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”: “Invalid access token”}
Respuesta (cuando los parámetros son incorrectos): {“result”: “Wrong parameters”}
Respuesta (Extended):
Respuesta: {“result”:{“sentitems_length”:[number of messages in database Sentitems folder],”status”:”ok”}}
Muestra de respuesta: {“result”: {“sentitems_length”:”21″,”status”:”ok”}}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (cuando los parámetros son incorrectos): {“result”: {“error_text”:”Wrong parameters”,”status”:”error”}}

Obtener la fuerza de la señal GSM/3G: Método HTTP GET

Método GET HTTP: https://url-of-smseagle/index.php/http_api/get_gsmsignal

Ejemplo:
https://url-of-smseagle/index.php/http_api/get_gsmsignal?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&modem_no=1

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
modem_no (parámetro opcional) número de módem a consultar (por defecto = 1). Se utiliza sólo en dispositivos multimodem
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML
Respuesta:
Respuesta: GSM/3G signal strength in percent (values between 0-100). If GSM/3G modem is disconnected from GSM/3G network, method returns -1
Muestra de respuesta: 74
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos): Wrong parameters
Respuesta (XML):

Respuesta:
<xml>
<signal_strength>
[GSM/3G signal strength in percent (values between 0-100)]
</signal_strength>
<status>ok</status>
</xml>

Muestra de respuesta:
<xml>
<signal_strength>74</signal_strength>
<status>ok</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text>Wrong parameters</error_text>
<status>error</status>
</xml>

Obtener la fuerza de la señal GSM/3G: Método JSONRPC

Método POST HTTP: https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”signal.get_gsmsignal”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
modem_no (parámetro opcional) número de módem a consultar (por defecto = 1). Se utiliza sólo en dispositivos multimodem
responsetype (parámetro opcional) simple = formato de respuesta como objeto simple con un campo de resultado (por defecto), extendido = formato de respuesta como objeto JSON extendido

Respueta:
Respuesta: {“result”: GSM/3G signal strength in percent: values between 0-100} If GSM/3G modem is disconnected from GSM/3G network, method returns -1.
Muestra de respuesta: {“result”:7}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”: “Invalid access token”}
Respuesta (cuando los parámetros son incorrectos): {“result”: “Wrong parameters”}

Respueta (Ampliada):
Respuesta: {“result”:{“signal_strength”:[number of messages in database Sentitems folder],”status”:”ok”}}
Muestra de respuesta: {“result”: {“signal_strength”:”7″,”status”:”ok”}}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}

Llamada con terminación: Método HTTP GET

Método GET HTTP: https://url-of-smseagle/index.php/http_api/call_with_termination

Ejemplo:
https://url-of-smseagle/index.php/http_api/call_with_termination?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&to=12345&duration=5

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
to número de teléfono al que llamar
duration duración de la conexión (en segundos)
modem_no (parámetro opcional) parámetro opcional) número de módem (por defecto = 1). Se utiliza sólo en dispositivos multimodales
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML
Respuesta:
Respuesta: OK
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password

Respuesta (cuando el token de acceso es incorrecto): Invalid access token

Respuesta (cuando el módem no soporta llamadas de voz): This modem doesn’t support voice calls
Respuesta (cuando los parámetros son incorrectos):
Wrong or missing >>to<< parameter
Wrong or missing >>duration<< parameter
Respuesta (when modem_no is wrong): Modem not recognized
Respuesta (XML):

Respuesta:
<xml>
<status>ok</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text>Wrong or missing >>duration<< parameter</error_text>
<status>error</status>
</xml>

Respuesta (cuando el módem no soporta llamadas de voz):
<xml>
<error_text>This modem doesn’t support voice calls</error_text>
<status>error</status>
</xml>

Respuesta (when modem_no is wrong):
<xml>
<error_text> Modem not recognized </error_text>
<status>error</status>
</xml>

Aviso importante: este método sólo está disponible para dispositivos Módem de voz 3G

Llamada con terminación: Método JSONRPC

Método POST HTTP: https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”phone.call_with_termination”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”to”:”123456789″, “duration”:”5″}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
to número de teléfono al que llamar
duration duración de la conexión (en segundos)
modem_no (parámetro opcional) llamando al número del módem (por defecto = 1). Se utiliza solo en dispositivos multimodales
responsetype (parámetro opcional) simple = formato de respuesta como objeto simple con un campo de resultado (por defecto), extendido = formato de respuesta como objeto JSON extendido

Respuesta:
Respuesta: {“result”: “OK”}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”:”Invalid access token”}
Respuesta (cuando el módem no soporta llamadas de voz): {“result”: “This modem doesn’t support voice calls”}
Respuesta (cuando los parámetros son incorrectos):
{“result”: “Wrong or missing >>to<< parameter”} {“result”: “Wrong or missing >>duration<< parameter”}
Respuesta (when modem_no is wrong): {“result”: ” Modem not recognized”}

Respuesta (Ampliada):
Respuesta: {“result”:{“status”:”ok”}}

Respuesta (cuando los datos de acceso son incorrectos): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (cuando el módem no soporta llamadas de voz):
{“result”: {“error_text”:”This modem doesn’t support voice calls”,”status”:”error”}}
Respuesta (cuando los parámetros son incorrectos):
{“result”: {“error_text”:”Wrong or missing >>to<< parameter”,”status”:”error”}}
{“result”: {“error_text”:”Wrong or missing >>duration<< parameter”,”status”:”error”}}

Respuesta (cuando modem_no es incorrecto):
{“result”: {“error_text”:”Modem not recognized”,”status”:”error”}}

Aviso importante: este método sólo está disponible para dispositivos modem de voz 3G

 

Obtener el estado del módem: Método HTTP GET

Método GET HTTP:
https://url-of-smseagle/index.php/http_api/get_modem_state

Ejemplo:
https://url-of-smseagle/index.php/http_api/get_modem_state?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&modem_no=1

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
modem_no (parámetro opcional) número de módem a consultar (por defecto = 1). Se utiliza sólo en dispositivos multimodem
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML

Respuesta:
Respuesta: enabled / disabled
Muestra de respuesta: enabled
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando el módem no existe): Wrong modem number

Respuesta (XML):
Respuesta:
<xml>
<modem_status>
enabled / disabled
</modem_status>
<status>ok</status>
</xml>

Muestra de respuesta:
<xml>
<modem_status>enabled</modem_status>
<status>ok</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando el módem no existe):
<xml>
<error_text> Wrong modem number</error_text>
<status>error</status>
</xml>

Obtener el estado del módem: Método JSONRPC

Método POST HTTP:
https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”sms.get_modem_state”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
modem_no (parámetro opcional) número de módem a consultar (por defecto = 1). Se utiliza sólo en dispositivos multimodales
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML

Respuesta:
{“result”: enabled / disabled }
Muestra de respuesta {“result”:”enabled”}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”:”Invalid access token”}
Respuesta (cuando el módem no existe): {“result”: “Wrong modem number”}

Respuesta (Ampliada):
Respuesta: {“result”:{“modem_status”: enabled / disabled,”status”:”ok”}}

Muestra de respuesta : {“result”: {“modem_status”:”Wrong modem number”,”status”:”ok”}}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (cuando el módem no existe): {“result”: {“error_text”:”Wrong modem number”,”status”:”error”}}

Establecer el estado del módem: Método HTTP GET

Método GET HTTP:
https://url-of-smseagle/index.php/http_api/set_modem_state

Ejemplo:
https://url-of-smseagle/index.php/http_api/set_modem_state?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&modem_no=1&status=enabled

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
modem_no (parámetro opcional) número de módem a consultar (por defecto = 1). Se utiliza sólo en dispositivos multimodem
status habilitado/ inhabilitado
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML

Respuesta:
Respuesta: OK
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando el módem no existe): Wrong modem number
Respuesta (cuando el estado del módem es incorrecto): Wrong modem state

Respuesta (XML):
Respuesta:
<xml>
<status>ok</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando el módem no existe):
<xml>
<error_text> Wrong modem number</error_text>
<status>error</status>
</xml>

Respuesta (cuando el estado del módem es incorrecto):
<xml>
<error_text>Wrong modem state</error_text>
<status>error</status>
</xml>

Establecer el estado del módem: Método JSONRPC

Método POST HTTP:
https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”sms.set_modem_state”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”, “status”:”enabled”}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
modem_no (parámetro opcional) número de módem para el cambio de estado (por defecto = 1). Se utiliza sólo en dispositivos multimodem
status habilitado/ inhabilitado
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML

Respuesta:
{“result”: enabled / disabled }

Muestra de respuesta: {“result”:”enabled”}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”:”Invalid access token”}
Respuesta (cuando el módem no existe): {“result”: “Wrong modem number”}
Respuesta (cuando el estado del módem es incorrecto): {“result”: “Wrong modem state”}

Respuesta (Ampliada):
Respuesta: {“result”:{“modem_status”: enabled / disabled,”status”:”ok”}}

Muestra de respuesta: {“result”: {“modem_status”:”Wrong modem number”,”status”:”ok”}}
Respuesta(cuando los datos de acceso son incorrectos): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta(cuando el módem no existe): {“result”: {“error_text”:”Wrong modem number”,”status”:”error”}}
Respuesta (cuando el estado del módem es incorrecto): {“result”: {“error_text”:”Wrong modem state”,”status”:”error”}}

Creación de un grupo de Directorio Telefónico: Método HTTP GET

Método GET HTTP: https://url-of-smseagle/index.php/http_api/group_create

Ejemplo:
https://url-of-smseagle/index.php/http_api/group_create?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&groupname=myusers&public=1

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
groupname nombre del grupo creado
public (parámetro opcional) 0 = grupo privado, 1 = grupo público
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML

Respuesta:
Respuesta: OK; ID=[ID of created group]
Muestra de respuesta: OK; ID=5
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos): Wrong or missing >>groupname<< parameter

Respuesta (XML):
Respuesta:
<xml>

<group_id>[ID of created group]</group_id>
<status>ok</status>
</xml>

Muestra de respuesta:
<xml>
<group_id>5</group_id>
<status>ok</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text>Wrong or missing >>groupname<< parameter</error_text>
<status>error</status>
</xml>

Creación de un grupo de Directorio Telefónico: Método JSONRPC

Método POST HTTP: https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”phonebook.group_create”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”groupname”:”myusers”,”public”:”1″}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
groupname nombre del grupo creado
public (parámetro opcional) 0 = grupo privado, 1 = grupo público
responsetype (parámetro opcional) simple = formato de respuesta como objeto simple con un campo de resultado (por defecto), extendido = formato de respuesta como objeto JSON extendido

Respuesta:
Respuesta: {“result”: “OK; ID=[ID of created group]”}
Tipo de respuesta: {“result”: “OK; ID=5”}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”:”Invalid access token”}
Respuesta (cuando los parámetros son incorrectos): {“result”: “Wrong or missing >>groupname<< parameter”}

Respuesta (Ampliada):
Respuesta: {“result”: {“group_id”:”[ID of created group]”,”status”:”ok”}}
Muestra de respuesta: {“result”: {“group_id”:”748″,”status”:”ok”}}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (cuando los parámetros son incorrectos): {“result”: {“error_text”:”Wrong parameters”,”status”:”error”}}

Lectura del grupo del Directorio Telefónico: Método HTTP GET

Método GET HTTP https://url-of-smseagle/index.php/http_api/group_read

Ejemplo:
https://url-of-smseagle/index.php/http_api/group_read?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&public=1&uid=12

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
public (parámetro opcional) 0 = grupo privado (valor por defecto), 1 = grupo público
uid (parámetro opcional) id del usuario que creó el grupo
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML
Respuesta:
Muestra de respuesta: link
Respuesta (cuando no hay datos): No data to display
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos):
Wrong or missing >>uid<< parameter
Wrong or missing >>public<< parameter
Respuesta (XML):
Muestra de respuesta:

<xml>
<groups>
<item>
<Name>private</Name>
<ID>2</ID>
<id_user>2</id_user>
<is_public>true</is_public>
</item>
<item>
<Name>Everyone</Name>
<ID>3</ID>
<id_user>1</id_user>
<is_public>true</is_public>
</item>
<item>
<Name>work</Name>
<ID>4</ID>
<id_user>1</id_user>
<is_public>true</is_public>
</item></groups>
<status>ok</status>
</xml>

Respuesta (cuando no hay datos):
<xml>
<error_text>No data to display</error_text>
<status>error</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text>Wrong or missing >>uid<< parameter</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text>Wrong or missing >>public<< parameter</error_text>
<status>error</status>
</xml>

Lectura del grupo del Directorio Telefónico: Método JSONRPC

Método POST HTTP: https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”phonebook.group_read”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”public”:”1″,”uid”:”12″}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
public (parámetro opcional) 0 = grupo privado (valor por defecto), 1 = grupo público
uid (parámetro opcional) id del usuario que creó el grupo
responsetype (parámetro opcional) simple = formato de respuesta como objeto simple con un campo de resultado (por defecto), extendido = formato de respuesta como objeto JSON extendido

Respuesta:
Muestra de respuesta: link

Respuesta (cuando no hay datos): {“result”: “No data to display”}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”: “Invalid access token”}
Respuesta (cuando los parámetros son incorrectos):
{“result”: “Wrong or missing >>uid<< parameter”}
{“result”: “Wrong or missing >>public<< parameter”}

Respuesta (Ampliada):
Muestra de respuesta: link
Respuesta (cuando los parámetros son incorrectos):
{“result”: {“error_text”:”Wrong or missing >>uid<< parameter”,”status”:”error”}}
{“result”: {“error_text”:”Wrong or missing >>public<< parameter”,”status”:”error”}}

Actualización del grupo del Directorio Telefónico: Método HTTP GET

Método GET HTTP: https://url-of-smseagle/index.php/http_api/group_update

Ejemplo:
https://url-of-smseagle/index.php/http_api/group_update?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&group_id=2&groupname=myusers&public=1

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
group_id id del grupo existente
groupname nombre del grupo
public (parámetro opcional) 0 = grupo privado, 1 = grupo público
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML

Respuesta:
Respuesta: OK
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos):
Wrong or missing >>groupname<< parameter
Wrong or missing >>group_id<< parameter
Respuesta (cuando group_id es incorrecto): Group with the given id does not exists

Respuesta (XML):
Respuesta:
<xml>
<status>ok</status>
</xml>
Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>
Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text>Wrong or missing >>groupname<< parameter</error_text>
<status>error</status>
</xml>
<xml>
<error_text>Wrong or missing >>group_id<< parameter</error_text>
<status>error</status>
</xml>
Respuesta (cuando group_id es incorrecto):
<xml>
<error_text>Group with the given id does not exists</error_text>
<status>error</status>
</xml>

Actualización del grupo del Directorio Telefónico: método JSONRPC

Método POST HTTP: https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”phonebook.group_update”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”group_id”:”2″,”groupname”:”myusers”,”public”:”1″}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
group_id id del grupo existente
groupname nombre del grupo
public (parámetro opcional) 0 = grupo privado, 1 = grupo público
responsetype (parámetro opcional) simple = formato de respuesta como objeto simple con un campo de resultado (por defecto), extendido = formato de respuesta como objeto JSON extendido

Respuesta:
Respuesta: OK
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos):
Wrong or missing >>groupname<< parameter
Wrong or missing >>group_id<< parameter
Respuesta (cuando group_id es incorrecto): Group with the given id does not exists

Respuesta (Extended):
Respuesta: {“result”:{“status”:”ok”}}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (cuando los parámetros son incorrectos): {“result”: {“error_text”:”Wrong or missing >>groupname<< parameter”,”status”:”error”}}{“result”: {“error_text”:”Wrong or missing >>group_id<< parameter”,”status”:”error”}}
Respuesta (cuando group_id es incorrecto): {“result”: {“error_text”:”Group with the given id does not exists”,”status”:”error”}}

Borrar grupo del Directorio Telefónico: Método HTTP GET

Método GET HTTP: https://url-of-smseagle/index.php/http_api/group_delete

Ejemplo:
https://url-of-smseagle/index.php/http_api/group_delete?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&group_id=2&groupname=myusers

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
group_id id del grupo existente
groupname nombre del grupo existente
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML
Respuesta:
Respuesta: OK
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos):
Wrong or missing >>groupname<< parameter
Wrong or missing >>group_id<< parameter
Respuesta (cuando group_id es incorrecto): Group with the given id and name does not exist

 

Respuesta (XML):
Respuesta:
<xml>
<status>ok</status>
</xml>Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text>Wrong or missing >>groupname<< parameter</error_text>
<status>error</status>
</xml><xml>
<error_text>Wrong or missing >>group_id<< parameter</error_text>
<status>error</status>
</xml>

Respuesta (cuando group_id es incorrecto):
<xml>
<error_text>Group with the given id does not exists</error_text>
<status>error</status>
</xml>

Borrar grupo del Directorio Telefónico: Método JSONRPC

Método POST HTTP: https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”phonebook.group_delete”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”group_id”:”2″,”groupname”:”myusers”}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
group_id id del grupo existente
groupname nombre del grupo existente
responsetype (parámetro opcional) simple = formato de respuesta como objeto simple con un campo de resultado (por defecto), extendido = formato de respuesta como objeto JSON extendido

Respuesta:
Respuesta: {“result”: “OK”}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”: “Invalid access token”}
Respuesta (cuando los parámetros son incorrectos):
{“result”: “Wrong or missing >>groupname<< parameter”}
{“result”: “Wrong or missing >>group_id<< parameter”}

Respuesta (cuando group_id es incorrecto): {“result”: “Group with the given id and name does not exist”}
Respuesta (Ampliada):
Respuesta: {“result”:{“status”:”ok”}}Respuesta (cuando los datos de acceso son incorrectos):
{“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (cuando los parámetros son incorrectos):
{“result”: {“error_text”:”Wrong or missing >>groupname<< parameter”,”status”:”error”}}{“result”: {“error_text”:”Wrong or missing >>group_id<< parameter”,”status”:”error”}}Respuesta (cuando group_id es incorrecto):
{“result”: {“error_text”:”Group with the given id does not exists”,”status”:”error”}}

El grupo del Directorio Telefónico añade el contacto: Método HTTP GET

Método GET HTTP: https://url-of-smseagle/index.php/http_api/group_addcontact

Ejemplo:
https://url-of-smseagle/index.php/http_api/group_addcontact?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&group_id=2&contact_id=1

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
group_id id del grupo existente (o los id están separados por una coma)
contact_id id del contacto. El contacto se añadirá al grupo
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML
Respuesta:
Respuesta: OK
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos):
Wrong or missing >>group_id<< parameter
Wrong or missing >>contact_id<< parameter
Respuesta (cuando el id es incorrecto):
Group with the given id does not exists
Contact with the given id does not exists

Respuesta (XML):
Respuesta:
<xml>
<status>ok</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text>Wrong or missing >>group_id<< parameter</error_text>
<status>error</status>
</xml><xml>
<error_text>Wrong or missing >>contact_id<< parameter</error_text>
<status>error</status>
</xml>

Respuesta (cuando el id es incorrecto):
<xml>
<error_text>Group with the given id does not exists</error_text>
<status>error</status>
</xml><xml>
<error_text>Contact with the given id does not exists</error_text>
<status>error</status>
</xml>

El grupo del Directorio Telefónico añade el contacto: Método JSONRPC

Método POST HTTP: https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”phonebook.group_addcontact”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”group_id”:”2″,”contact_id”:”1″}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
group_id id del grupo existente (o los id están separados por una coma)
contact_id id del contacto. El contacto se añadirá al grupo
responsetype (parámetro opcional) simple = formato de respuesta como objeto simple con un campo de resultado (por defecto), extendido = formato de respuesta como objeto JSON extendido
Respuesta:
Respuesta: {“result”: “OK”}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”: “Invalid access token”}
Respuesta (cuando los parámetros son incorrectos):
{“result”: “Wrong or missing >>group_id<< parameter”}
{“result”: “Wrong or missing >>contact_id<< parameter”}
Respuesta (cuando el id es incorrecto):
{“result”: “Group with the given id does not exists”}
{“result”: “Contact with the given id does not exists”}
Respuesta (Ampliada):
Respuesta: {“result”:{“status”:”ok”}}Respuesta (cuando los datos de acceso son incorrectos):
{“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (cuando los parámetros son incorrectos):
{“result”: {“error_text”:”Wrong or missing >>group_id<< parameter”,”status”:”error”}}{“result”: {“error_text”:”Wrong or missing >>contact_id<< parameter”,”status”:”error”}}Respuesta (cuando el id es incorrecto):
{“result”: {“error_text”:”Group with the given id does not exists”,”status”:”error”}}{“result”: {“error_text”:”Contact with the given id does not exists”,”status”:”error”}}

El grupo del Directorio Telefónico elimina el contacto: Método HTTP GET

Método GET HTTP: https://url-of-smseagle/index.php/http_api/group_removecontact

Ejemplo:
https://url-of-smseagle/index.php/http_api/group_removecontact?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&group_id=2&contact_id=1

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
group_id id del grupo existente (o los id están separados por una coma)
contact_id id del contacto. El contacto será retirado del grupo
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML
Respuesta:
Respuesta: OK
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos):
Wrong or missing >>group_id<< parameter
Wrong or missing >>contact_id<< parameter
Respuesta (cuando el id es incorrecto):
Group with the given id does not exists
Contact with the given id does not exists

Respuesta (XML):
Respuesta:
<xml>
<status>ok</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text>Wrong or missing >>group_id<< parameter</error_text>
<status>error</status>
</xml><xml>
<error_text>Wrong or missing >>contact_id<< parameter</error_text>
<status>error</status>
</xml>

Respuesta (cuando el id es incorrecto):
<xml>
<error_text>Group with the given id does not exists</error_text>
<status>error</status>
</xml><xml>
<error_text>Contact with the given id does not exists</error_text>
<status>error</status>
</xml>

El grupo del Directorio Telefónico elimina el contacto: Método JSONRPC

Método POST HTTP: https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”phonebook.group_removecontact”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”group_id”:”2″,”contact_id”:”1″}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
group_id id del grupo existente (o los id están separados por una coma)
contact_id id del contacto. El contacto será retirado del grupo
responsetype (parámetro opcional) simple = formato de respuesta como objeto simple con un campo de resultado (por defecto), extendido = formato de respuesta como objeto JSON extendido
Respuesta:
Respuesta: {“result”: “OK”}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”: “Invalid access token”}
Respuesta (cuando los parámetros son incorrectos):
{“result”: “Wrong or missing >>group_id<< parameter”}
{“result”: “Wrong or missing >>contact_id<< parameter”}
Respuesta (cuando el id es incorrecto):
{“result”: “Group with the given id does not exists”}
{“result”: “Contact with the given id does not exists”}
Respuesta (Extended):
Respuesta: {“result”:{“status”:”ok”}}
Respuesta (cuando los datos de acceso son incorrectos):
{“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (cuando los parámetros son incorrectos):
{“result”: {“error_text”:”Wrong or missing >>group_id<< parameter”,”status”:”error”}}
{“result”: {“error_text”:”Wrong or missing >>contact_id<< parameter”,”status”:”error”}}
Respuesta (cuando el id es incorrecto):
{“result”: {“error_text”:”Group with the given id does not exists”,”status”:”error”}}
{“result”: {“error_text”:”Contact with the given id does not exists”,”status”:”error”}}

Lectura de los miembros del grupo del Directorio Telefónico: Método HTTP GET

Método GET HTTP:
https://url-of-smseagle/index.php/http_api/group_members_read

Ejemplo:
https://url-of-smseagle/index.php/http_api/group_members_read?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&group_id=11

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
group_id ID del grupo que se va a consultar
user_id (parámetro opcional) muestran sólo los contactos creados por el usuario con un ID determinado
public (parámetro opcional) 0 = privado, 1 = público
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML

Respuesta:
Muestra de respuesta: link
Respuesta (when wrong or missing group_id parameter): Wrong or missing >>group_id<< parameter
Respuesta (when wrong user_id parameter): Wrong >>user_id<< parameter
Respuesta (when wrong public parameter): Wrong >>public<< parameter
Respuesta (when result set is empty): No data to display

Respuesta (XML):

Respuesta:
<xml>
<contacts>
<contact>
<ID>17</ID>
<Name>mycontact1</Name>
<Number>23456</Number>
<id_user>1</id_user>
<is_public>true</is_public>
</contact>
<contact>
<ID>24</ID>
<Name>mycontact3</Name>
<Number>12345</Number>
<id_user>3</id_user>
<is_public>false</is_public>
</contact>
</contacts>
</xml>

Respuesta (when wrong or missing group_id parameter):
<xml>
<error_text>Wrong or missing >>group_id<< parameter</error_text>
<status>error</status>
</xml>

Respuesta (when wrong user_id parameter):
<xml>
<error_text>Wrong >>user_id<< parameter</error_text>
<status>error</status>
</xml>

Respuesta (when wrong public parameter):
<xml>
<error_text> Wrong >>public<< parameter </error_text>
<status>error</status>
</xml>

Lectura de los miembros del grupo del Directorio Telefónico: Método JSONRPC

Método POST HTTP:
https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”phonebook.group_members_read”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”group_id”:”11″}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
group_id ID del grupo que se va a consultar
user_id (parámetro opcional) muestran sólo los contactos creados por el usuario con un ID determinado
public (parámetro opcional) 0 = privado, 1 = público
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML

Respuesta:
Muestra de respuesta:
{
“result”: [
{“ID”:”1706″,”Name”:”mycontact1″,”Number”:”23456″,
“id_user”:”1″,”is_public”:”true”},
{“ID”:”1693″,”Name”:”mycontact3″,”Number”:”12345″,
“id_user”:”3″,”is_public”:”false”}]
}

Respuesta (when wrong or missing group_id parameter): {“result”: “Wrong or missing >>group_id<< parameter”}
Respuesta (when wrong user_id parameter): {“result”: “Wrong >>user_id<< parameter”}
Respuesta (when wrong public parameter): {“result”: “Wrong >>public<< parameter”}

Respuesta (Ampliada):
Muestra de respuesta:
{
“result”: {
“contacts”: [
{“ID”:”1706″,”Name”:”mycontact1″,”Number”:”23456″,
“id_user”:”1″,”is_public”:”true”},
{“ID”:”1693″,”Name”: “mycontact3″,”Number”:”12345″,
“id_user”:”3″,”is_public”:”false”}],
“status”: “ok”}
}

Respuesta (cuando los datos de acceso son incorrectos): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (when wrong or missing group_id parameter): {“result”: {“error_text”:”Wrong or missing >>group_id<< parameter”,”status”:”error”}}
Respuesta (when wrong user_id parameter): {“result”: “Wrong >>user_id<< parameter”}
Respuesta (when wrong public parameter): {“result”: “Wrong >>public<< parameter”}

Crear un contacto en el Directorio Telefónico: Método HTTP GET

Método GET HTTP: https://url-of-smseagle/index.php/http_api/contact_create

Ejemplo:
https://url-of-smseagle/index.php/http_api/contact_create?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&contactname=johndoe&number=12345678&public=1

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
contactname nombre del contacto creado
number número de teléfono del contacto creado
public (parámetro opcional) 0 = privado, 1 = público (valor por defecto)
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML
Respuesta:
Respuesta: OK; ID=[ID of created contact]
Muestra de respuesta: OK; ID=2
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos):
Wrong or missing >>contactname<< parameter
Wrong or missing >>number<< parameter

Respuesta (XML):
Respuesta:
<xml>
<contact_id>[ID of created contact]</contact_id>
<status>ok</status>
</xml>

Muestra de respuesta:
<xml>
<contact_id>2</contact_id>
<status>ok</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text>Wrong or missing >>contactname<< parameter</error_text>
<status>error</status>
</xml><xml>
<error_text>Wrong or missing >>number<< parameter</error_text>
<status>error</status>
</xml>

Crear un contacto en el Directorio Telefónico: Método JSONRPC

Método POST HTTP: https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”phonebook.contact_create”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”contactname”:”johndoe”,”number”:”12345678″,”public”:”1″}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
contactname nombre del contacto creado
number número de teléfono del contacto creado
public (parámetro opcional) 0 = privado, 1 = público (valor por defecto)
responsetype (parámetro opcional) simple = formato de respuesta como objeto simple con un campo de resultado (por defecto), extendido = formato de respuesta como objeto JSON extendido
Respuesta:
Respuesta: {“result”: “OK; ID=[ID of created contact]”}
Muestra de respuesta: {“result”: “OK; ID=2”}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”: “Invalid access token”}
Respuesta (cuando los parámetros son incorrectos):
{“result”: “Wrong or missing >>contactname<< parameter”}
{“result”: “Wrong or missing >>number<< parameter”}
Respuesta (Ampliada):
Respuesta:
{“result”: {“contact_id”:”[ID of created contact]”,”status”:”ok”}}Muestra de respuesta: {“result”: {“contact_id”:”2″,”status”:”ok”}}Respuesta (cuando los datos de acceso son incorrectos):
{“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (cuando los parámetros son incorrectos):
{“result”: {“error_text”:”Wrong or missing >>contactname<< parameter”},”status”:”error”}}{“result”: {“error_text”:”Wrong or missing >>number<< parameter”,”status”:”error”}}

Lectura del contacto del Directorio Telefónico: Método HTTP GET

Método GET HTTP: https://url-of-smseagle/index.php/http_api/contact_read

Ejemplo:
https://url-of-smseagle/index.php/http_api/contact_read?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&public=1&uid=12

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
public (parámetro opcional) 0 = contactos privados (valor por defecto), 1 = contactos públicos
uid (parámetro opcional) id del usuario que creó el contacto
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML
Respuesta:
Muestra de respuesta: link
Respuesta (cuando no hay datos): No data to display
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos):
Wrong or missing >>uid<< parameter
Wrong or missing >>public<< parameter

Respuesta (XML):
Muestra de respuesta: link

Respuesta (cuando no hay datos):
<xml>
<error_text>No data to display</error_text>
<status>error</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text>Wrong or missing >>uid<< parameter</error_text>
<status>error</status>
</xml>
<xml>
<error_text>Wrong or missing >>public<< parameter</error_text>
<status>error</status>
</xml>

Lectura del contacto del Directorio Telefónico: Método JSONRPC

Método POST HTTP: https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”phonebook.contact_read”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”public”:”1″,”uid”:”12″}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
public (parámetro opcional) 0 = contactos privados (valor por defecto), 1 = contactos públicos
uid (parámetro opcional) id del usuario que creó el contacto
responsetype (parámetro opcional) simple = formato de respuesta como objeto simple con un campo de resultado (por defecto), extendido = formato de respuesta como objeto JSON extendido
Respuesta:
Muestra de respuesta: link
Respuesta (cuando no hay datos): {“result”: “No data to display”}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”: “Invalid access token”}
Respuesta (cuando los parámetros son incorrectos):
{“result”: “Wrong or missing >>uid<< parameter”}
{“result”: “Wrong or missing >>public<< parameter”}
Respuesta (Ampliada):
Muestra de respuesta: link
Respuesta (cuando no hay datos):
{“result”: {“error_text”:” No data to display”,”status”:”error”}}
Respuesta (cuando los datos de acceso son incorrectos):
{“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (cuando los parámetros son incorrectos):
{“result”: {“error_text”:”Wrong or missing >>uid<< parameter”,”status”:”error”}}{“result”: {“error_text”:”Wrong or missing >>public<< parameter”,”status”:”error”}}

Actualización del contacto del Directorio Telefónico: Método HTTP GET

Método GET HTTP: https://url-of-smseagle/index.php/http_api/contact_update

Ejemplo:
https://url-of-smseagle/index.php/http_api/contact_update?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&contact_id=4&contactname=johnlord&number=123456789&public=1

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
contact_id id del contacto existente
contactname nombre del contacto
number número de teléfono del contacto
public (parámetro opcional) 0 = grupo privado, 1 = grupo público
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML
Respuesta:
Respuesta: OK
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos):
Wrong or missing >>contactname<< parameter
Wrong or missing >>contact_id<< parameter
Wrong or missing >>number<< parameter
Respuesta (cuando el contact_id es incorrecto): Contact with the given id does not exists

Respuesta (XML):
Respuesta:
<xml>
<status>ok</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text>Wrong or missing >>contactname<< parameter</error_text>
<status>error</status>
</xml>
<xml>
<error_text>Wrong or missing >>contact_id<< parameter</error_text>
<status>error</status>
</xml>
<xml>
<error_text>Wrong or missing >>number<< parameter</error_text>
<status>error</status>
</xml>

Respuesta (cuando el contact_id es incorrecto):
<xml>
<error_text>Contact with the given id does not exists</error_text>
<status>error</status>
</xml>

Actualización del contacto del Directorio Telefónico: método JSONRPC

Método POST HTTP: https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”phonebook.contact_update”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”contact_id”:”4″,”contactname”:”johnlord”,”number”:”123456789″,”public”:”1″}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
contact_id id del contacto existente
contactname nombre del contacto
number número de teléfono del contacto
public (parámetro opcional) 0 = grupo privado, 1 = grupo público
responsetype (parámetro opcional) simple = formato de respuesta como objeto simple con un campo de resultado (por defecto), extendido = formato de respuesta como objeto JSON extendido
Respuesta:
Respuesta: {“result”: “OK”}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”: “Invalid access token”}
Respuesta (cuando los parámetros son incorrectos):
{“result”: “Wrong or missing >>contactname<< parameter”}
{“result”: “Wrong or missing >>contact_id<< parameter”}
{“result”: “Wrong or missing >>number<< parameter”}
Respuesta (cuando el contact_id es incorrecto): {“result”: “Contact with the given id does not exists”}
Respuesta (Extended):
Respuesta: {“result”:{“status”:”ok”}}
Respuesta (cuando los datos de acceso son incorrectos):
{“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (cuando los parámetros son incorrectos):
{“result”: {“error_text”:”Wrong or missing >>contactname<< parameter”,”status”:”error”}}
{“result”: {“error_text”:”Wrong or missing >>contact_id<< parameter”,”status”:”error”}}
{“result”: {“error_text”:”Wrong or missing >>number<< parameter”,”status”:”error”}}
Respuesta (cuando el contact_id es incorrecto):
{“result”: {“error_text”:”Contact with the given id does not exists”,”status”:”error”}}

Borrar contacto del Directorio Telefónico: Método HTTP GET

Método GET HTTP: https://url-of-smseagle/index.php/http_api/contact_delete

Ejemplo:
https://url-of-smseagle/index.php/http_api/contact_delete?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&contact_id=4&contactname=johnlord

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
contact_id id del contacto existente
contactname nombre del contacto existente
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML
Respuesta:
Respuesta: OK
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos):
Wrong or missing >>contactname<< parameter
Wrong or missing >>contact_id<< parameter
Respuesta (cuando group_id es incorrecto): Contact with the given id and name does not exists
Respuesta (XML):
Respuesta:
<xml>
<status>ok</status>
</xml>
Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>
Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text>Wrong or missing >>contactname<< parameter</error_text>
<status>error</status>
</xml>
<xml>
<error_text>Wrong or missing >>contact_id<< parameter</error_text>
<status>error</status>
</xml>
Respuesta (cuando el contact_id es incorrecto):
<xml>
<error_text>Contact with the given id and name does not exists </error_text>
<status>error</status>
</xml>

Borrar contacto del Directorio Telefónico: Método JSONRPC

Método POST HTTP: https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”phonebook.contact_delete”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”contact_id”:”4″,”contactname”:”johnlord”}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
contact_id id del contacto existente
contactname nombre del contacto existente
responsetype (parámetro opcional) simple = formato de respuesta como objeto simple con un campo de resultado (por defecto), extendido = formato de respuesta como objeto JSON extendido
Respuesta:
Respuesta: {“result”: “OK”}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”: “Invalid access token”}
Respuesta (cuando los parámetros son incorrectos):
{“result”: “Wrong or missing >>contactname<< parameter”}
{“result”: “Wrong or missing >>contact_id<< parameter”}
Respuesta (cuando group_id es incorrecto): {“result”: “Contact with the given id and name does not exists”}
Respuesta (Extended):
Respuesta: {“result”:{“status”:”ok”}}
Respuesta (cuando los datos de acceso son incorrectos):
{“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (cuando los parámetros son incorrectos):
{“result”: {“error_text”:”Wrong or missing >>contactname<< parameter”,”status”:”error”}}
{“result”: {“error_text”:”Wrong or missing >>contact_id<< parameter”,”status”:”error”}}
Respuesta (cuando el contact_id es incorrecto):
{“result”: {“error_text”:”Contact with the given id and name does not exists”,”status”:”error”}}

Crear turno en el Directorio Telefónico: Método HTTP GET

Método GET HTTP: https://url-of-smseagle/index.php/http_api/shift_create

Ejemplo:
https://url-of-smseagle/index.php/http_api/shift_create?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&name=myshift&mon_from=08:00&mon_to=16:00&wed_from=09:00&wed_to=20:00&enabled=1

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
name nombre para el turno creado
enabled 0 = inhabilitado, 1 = habilitado
(mon-sun)_from hora de inicio del turno para cada día de la semana
(mon-sun)_to hora del final del turno para cada día de la semana
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML

Respuesta:
Respuesta: OK; ID=[ID of created shift]
Muestra de respuesta: OK; ID=5
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos): Wrong or missing >>name<< parameter

Respuesta (XML):
Respuesta:
<xml>
<shift_id>[ID of created shift]</shift_id>
<status>ok</status>
</xml>

Muestra de respuesta:
<xml>
<shift_id>5</shift_id>
<status>ok</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text>Wrong or missing >>name<< parameter</error_text>
<status>error</status>
</xml>

Crear turno en el Directorio Telefónico: Método JSONRPC

Método POST HTTP: https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”phonebook.shift_create”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”name”:”myshift”,”mon_from”:”08:00″,”mon_to”:”16:00″,”wed_from”:”09:00″,”wed_to”:”20:00″,”enabled”:”1″}}

Parámetro Description
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
name nombre para el turno creado
enabled 0 = inhabilitado, 1 = habilitado
(mon-sun)_from hora de inicio del turno para cada día de la semana
(mon-sun)_to hora del final del turno para cada día de la semana
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML

Respuesta:
Respuesta: {“result”: “OK; ID=[ID of created shift]”}
Muestra de respuesta: {“result”: “OK; ID=5”}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”:”Invalid access token”}
Respuesta (cuando los parámetros son incorrectos): {“result”: “Wrong or missing >>name<< parameter”}

Respuesta (Ampliada):
Respuesta: {“result”: {“shift_id”:”[ID of created shift]”,”status”:”ok”}}
Muestra de respuesta: {“result”: {“shift_id”:”748″,”status”:”ok”}}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (cuando los parámetros son incorrectos): {“result”: {“error_text”:” Wrong or missing >>name<< parameter “,”status”:”error”}}

Lectura del turno del Directorio Telefónico: Método HTTP GET

Método GET HTTP:
https://url-of-smseagle/index.php/http_api/shift_read

Ejemplo:
https://url-of-smseagle/index.php/http_api/shift_read?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&name=myshift

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
name (parámetro opcional) nombre del turno
enabled (parámetro opcional) 0 = inhabilitado, 1 = habilitado
shift_id (parámetro opcional) shift id
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML

Respuesta:
Muestra de respuesta: link
Respuesta (cuando no hay datos): No data to display
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos):
Wrong >>shift_id<< parameter

Respuesta (XML):
Muestra de respuesta:
<xml>
<shifts>
<shift>
<id_shift>62</id_shift>
<name>myshift</name>
<mon_from>08:00</mon_from>
<mon_to>16:00</mon_to>
<tue_from/>
<tue_to/>
<wed_from>09:00</wed_from>
<wed_to>20:00</wed_to>
<thu_from/>
<thu_to/>
<fri_from/>
<fri_to/>
<sat_from/>
<sat_to/>
<sun_from/>
<sun_to/>
<enabled>true</enabled>
</shift>
</shifts>
<status>ok</status>
</xml>

Respuesta (cuando no hay datos):
<xml>
<error_text>No data to display</error_text>
<status>error</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text> Wrong >>id<< parameter</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text> Wrong >>enabled<< parameter</error_text>
<status>error</status>
</xml>

Lectura del turno del Directorio Telefónico: Método JSONRPC

HTTP POST method:
https://url-of-smseagle/index.php/jsonrpc/sms

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
name (parámetro opcional) nombre del turno
enabled (parámetro opcional) 0 = inhabilitado, 1 = habilitado
shift_id (parámetro opcional) shift id
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML

 

Ejemplos:
{“method”:”phonebook.shift_read”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”name”:”myshift”}}

 

Respuesta:
Muestra de respuesta:

{
“result”: [
{
“id_shift”: “62”,
“name”: “myshift”,
“mon_from”: “08:00”,
“mon_to”: “16:00”,
“tue_from”: null,
“tue_to”: null,
“wed_from”: “09:00”,
“wed_to”: “20:00”,
“thu_from”: null,
“thu_to”: null,
“fri_from”: null,
“fri_to”: null,
“sat_from”: null,
“sat_to”: null,
“sun_from”: null,
“sun_to”: null,
“enabled”: “true”
}
]
}
Respuesta (cuando no hay datos): {“result”: “No data to display”}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”:”Invalid access token”}
Respuesta (cuando los parámetros son incorrectos):
{“result”: “Wrong >> enabled<< parameter”}
{“result”: “Wrong >>shift_id<< parameter”}

 

Respuesta (AMPLIADA):
Muestra de respuesta:
{
“result”: {
“shifts”: [
{
“id_shift”: “62”,
“name”: “myshift”,
“mon_from”: “08:00”,
“mon_to”: “16:00”,
“tue_from”: null,
“tue_to”: null,
“wed_from”: “09:00”,
“wed_to”: “20:00”,
“thu_from”: null,
“thu_to”: null,
“fri_from”: null,
“fri_to”: null,
“sat_from”: null,
“sat_to”: null,
“sun_from”: null,
“sun_to”: null,
“enabled”: “false”
}
],
“status”: “ok”
}
}

Respuesta (cuando no hay datos):

{“result”: {“error_text”:” No data to display”,”status”:”error”}}

Respuesta (cuando los datos de acceso son incorrectos):

{“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}

Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}

Respuesta (cuando los parámetros son incorrectos):

{“result”: {“error_text”:” Wrong >> enabled<< parameter “,”status”:”error”}}

 

{“result”: {“error_text”:” Wrong >> shift_id<< parameter “,”status”:”error”}}

Actualización del turno del Directorio Telefónico: Método HTTP GET

Método GET HTTP:
https://url-of-smseagle/index.php/http_api/shift_update

Ejemplo:
https://url-of-smseagle/index.php/http_api/shift_update?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&shift_id=24&name=updatedshift&enabled=1

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
shift_id id del turno existente
name nombre para el turno
enabled 0 = inhabilitado, 1 = habilitado
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML

Respuesta:
Respuesta: OK
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos):
Wrong or missing >>name<< parameter
Wrong or missing >>shift_id<< parameter
Respuesta (cuando el shift_id es incorrecto): Shift with the given id does not exists

Respuesta (XML):
Respuesta:
<xml>
<status>ok</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text>Wrong or missing >>name<< parameter</error_text>
<status>error</status>
</xml>

<xml>
<error_text>Wrong or missing >>shift_id<< parameter</error_text>
<status>error</status>
</xml>

Respuesta (cuando el shift_id es incorrecto):
<xml>
<error_text>Shift with given id does not exists</error_text>
<status>error</status>
</xml>

Actualización del turno del Directorio Telefónico: JSONRPC method

Método POST HTTP:
https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”phonebook.shift_update”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”shift_id”:”24″,”name”:”updatedshift”,”enabled”:”1″}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
shift_id id del turno existente
name nombre para el turno
enabled 0 = inhabilitado, 1 = habilitado
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML

Respuesta:
Respuesta: {“result”: “OK”}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”:”Invalid access token”}
Respuesta (cuando los parámetros son incorrectos):
{“result”: “Wrong or missing >>name<< parameter”}
{“result”: “Wrong or missing >>shift_id<< parameter”}
Respuesta (cuando el shift_id es incorrecto): {“result”: “Shift with the given id does not exists”}

Respuesta (Extended):
Respuesta: {“result”:{“status”:”ok”}}

Respuesta (cuando los datos de acceso son incorrectos): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (cuando los parámetros son incorrectos):
{“result”: {“error_text”:”Wrong or missing >>name<< parameter”,”status”:”error”}}
{“result”: {“error_text”:”Wrong or missing >>shift_id<< parameter”,”status”:”error”}}

Respuesta (cuando el shift_id es incorrecto): {“result”: {“error_text”:”Shift with the given id does not exists”,”status”:”error”}}

Borrar el turno del Directorio Telefónico: Método HTTP GET

Método GET HTTP:
https://url-of-smseagle/index.php/http_api/shift_delete

Ejemplo:
https://url-of-smseagle/index.php/http_api/shift_delete?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&shift_id=24

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
shift_id id del turno existente
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML

Respuesta:
Respuesta: OK
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos):
Wrong or missing >>shift_id<< parameter
Respuesta (cuando el shift_id es incorrecto): Shift with the given id does not exist

Respuesta (XML):
Respuesta:
<xml>
<status>ok</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

<xml>
<error_text>Wrong or missing >>shift_id<< parameter</error_text>
<status>error</status>
</xml>

Respuesta (cuando el shift_id es incorrecto):
<xml>
<error_text>Shift with the given id does not exists</error_text>
<status>error</status>
</xml>

Borrar el turno del Directorio Telefónico: JSONRPC method

Método POST HTTP:
https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”phonebook.shift_delete”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”shift_id”:”24″}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
shift_id id del turno existente
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML

Respuesta:
Respuesta: {“result”: “OK”}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”:”Invalid access token”}
Respuesta (cuando los parámetros son incorrectos):
{“result”: “Wrong or missing >>shift_id<< parameter”}
Respuesta (cuando el shift_id es incorrecto): {“result”: “Shift with the given id does not exist”}

Respuesta (Ampliada):
Respuesta: {“result”:{“status”:”ok”}}

Respuesta (cuando los datos de acceso son incorrectos): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (cuando los parámetros son incorrectos): {“result”: {“error_text”:”Wrong or missing >>shift_id<< parameter”,”status”:”error”}}
Respuesta (cuando el shift_id es incorrecto): {“result”: {“error_text”:”Shift with the given id does not exists”,”status”:”error”}}

El turno del Directorio Telefónico añade el contacto: Método HTTP GET

Método GET HTTP:
https://url-of-smseagle/index.php/http_api/shift_addcontact

Ejemplo:
https://url-of-smseagle/index.php/http_api/shift_addcontact?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&shift_id=2&contact_id=1

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
shift_id id del turno existente (o los id separados por una coma)
contact_id id del contacto. El contacto se añadirá al turno
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML

Respuesta:
Respuesta: OK
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos):
Wrong or missing >>shift_id<< parameter
Wrong or missing >>contact_id<< parameter
Respuesta (cuando el id es incorrecto):
Shift with the given id does not exists
Contact with the given id does not exists

Respuesta (XML):
Respuesta:
<xml>
<status>ok</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text>Wrong or missing >>shift_id<< parameter</error_text>
<status>error</status>
</xml>

<xml>
<error_text>Wrong or missing >>contact_id<< parameter</error_text>
<status>error</status>
</xml>

Respuesta (cuando el id es incorrecto):
<xml>
<error_text>Shift with the given id does not exists</error_text>
<status>error</status>
</xml>

<xml>
<error_text>Contact with the given id does not exists</error_text>
<status>error</status>
</xml>

El turno del Directorio Telefónico añade el contacto: JSONRPC method

Método POST HTTP:
https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”phonebook.shift_addcontact”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”shift_id”:”24″,”contact_id”:”1″}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
shift_id id del turno existente (o los id separados por una coma)
contact_id id del contacto. El contacto se añadirá al turno
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML

Respuesta:
Respuesta: {“result”: “OK”}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”:”Invalid access token”}
Respuesta (cuando los parámetros son incorrectos):
{“result”: “Wrong or missing >>shift_id<< parameter”}
{“result”: “Wrong or missing >>contact_id<< parameter”}
Respuesta (cuando el id es incorrecto):
{“result”: “Shift with the given id does not exists”}
{“result”: “Contact with the given id does not exists”}

Respuesta (Ampliada):
Respuesta: {“result”:{“status”:”ok”}}

Respuesta (cuando los datos de acceso son incorrectos): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (cuando los parámetros son incorrectos):
{“result”: {“error_text”:”Wrong or missing >>shift_id<< parameter”,”status”:”error”}}
{“result”: {“error_text”:”Wrong or missing >>contact_id<< parameter”,”status”:”error”}}

Respuesta (cuando el id es incorrecto):
{“result”: {“error_text”:”Shift with the given id does not exists”,”status”:”error”}}
{“result”: {“error_text”:”Contact with the given id does not exists”,”status”:”error”}}

El turno de Directorio Telefónico remueve el contacto: Método HTTP GET

Método GET HTTP:
https://url-of-smseagle/index.php/http_api/shift_removecontact

Ejemplo:
https://url-of-smseagle/index.php/http_api/shift_removecontact?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&shift_id=24&contact_id=1

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
shift_id id del turno existente (o los id separados por una coma)
contact_id id del contacto. El contacto se añadirá al turno
tipoderepuesta (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML

Respuesta:
Respuesta: OK
Respuesta (cuando los datos de acceso son incorrectos): Invalid login or password
Respuesta (cuando el token de acceso es incorrecto): Invalid access token
Respuesta (cuando los parámetros son incorrectos):
Wrong or missing >>shift_id<< parameter
Wrong or missing >>contact_id<< parameter
Respuesta (cuando el id es incorrecto):
Shift with the given id does not exists
Contact with the given id does not exists

Respuesta (XML):
Respuesta:
<xml>
<status>ok</status>
</xml>

Respuesta (cuando los datos de acceso son incorrectos):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Respuesta (cuando el token de acceso es incorrecto):
<xml>
<error_text>Invalid access token</error_text>
<status>error</status>
</xml>

Respuesta (cuando los parámetros son incorrectos):
<xml>
<error_text>Wrong or missing >>shift_id<< parameter</error_text>
<status>error</status>
</xml>

<xml>
<error_text>Wrong or missing >>contact_id<< parameter</error_text>
<status>error</status>
</xml>

Respuesta (cuando el id es incorrecto):
<xml>
<error_text>Shift with the given id does not exists</error_text>
<status>error</status>
</xml>

<xml>
<error_text>Contact with the given id does not exists</error_text>
<status>error</status>
</xml>

El turno de Directorio Telefónico remueve el contacto: JSONRPC method

Método POST HTTP:
https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”phonebook.shift_removecontact”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”shift_id”:”24″,”contact_id”:”1″}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
shift_id id del turno existente (o los id separados por una coma)
contact_id id del contacto. El contacto se añadirá al turno
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML

Respuesta:
Respuesta: {“result”: “OK”}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: “Invalid login or password”}
Respuesta (cuando el token de acceso es incorrecto): {“result”:”Invalid access token”}
Respuesta (cuando los parámetros son incorrectos):
{“result”: “Wrong or missing >>shift_id<< parameter”}
{“result”: “Wrong or missing >>contact_id<< parameter”}
Respuesta (cuando el id es incorrecto):
{“result”: “Shift with the given id does not exists”}
{“result”: “Contact with the given id does not exists”}

Respuesta (Ampliada):
Respuesta: {“result”:{“status”:”ok”}}

Respuesta (cuando los datos de acceso son incorrectos): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (cuando los parámetros son incorrectos):
{“result”: {“error_text”:”Wrong or missing >>shift_id<< parameter”,”status”:”error”}}
{“result”: {“error_text”:”Wrong or missing >>contact_id<< parameter”,”status”:”error”}}

Respuesta (cuando el id es incorrecto):
{“result”: {“error_text”:”Shift with the given id does not exists”,”status”:”error”}}
{“result”: {“error_text”:”Contact with the given id does not exists”,”status”:”error”}}

Lectura del ID del usuario: Método HTTP GET

Método GET HTTP:
https://url-of-smseagle/index.php/http_api/userid_read

Ejemplo:
https://url-of-smseagle/index.php/http_api/userid_read?access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&username=myuser

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
username nombre de usuario para ser consultado
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML

Respuesta:
Respuesta: User ID
Muestra de respuesta: 24
Respuesta (cuando falta el parámetro del nombre de usuario): Missing >>username<< parameter
Respuesta (cuando el usuario no existe): Wrong >>username<< parameter

Respuesta (XML):
Respuesta:
<xml>
<status>ok</status>
</xml>

Respuesta (cuando falta el parámetro del nombre de usuario):
<xml>
<error_text>Missing >>username<< parameter</error_text>
<status>error</status>
</xml>

Respuesta (cuando el usuario no existe):
<xml>
<error_text>Wrong >>username<< parameter</error_text>
<status>error</status>
</xml>

Lectura del ID del usuario: JSONRPC method

Método POST HTTP:
https://url-of-smseagle/index.php/jsonrpc/sms

Cuerpo de muestra:
{“method”:”phonebook.userid_read”, “params”:{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,”username”:”myuser”}}

Parámetro Descripción
access_token token de acceso a la autenticación (ver detalles en el punto Autenticación API)
login su usuario para acceder a SMSEagle (ver detalles en el punto Autenticación API)
pass su contraseña para acceder a SMSEagle
username nombre de usuario para ser consultado
responsetype (parámetro opcional) texto = respuesta de formato como texto (por defecto), xml = respuesta de formato como objeto XML

Respuesta:
{“result”: [user ID] }
Muestra de respuesta: {“result”:”24″}
Respuesta (cuando falta el parámetro del nombre de usuario): {“result”: “Missing >>username<< parameter”}
Respuesta (cuando el usuario no existe): {“result”: “Wrong >>username<< parameter”}

Respuesta (Ampliada):
Respuesta:
{“result”:{“uid”: [user ID],”status”:”ok”}}

Muestra de respuesta: {“result”: {“uid”:”24″,”status”:”ok”}}
Respuesta (cuando los datos de acceso son incorrectos): {“result”: {“error_text”:”Invalid login or password”,”status”:”error”}}
Respuesta (cuando el token de acceso es incorrecto): {“result”: {“error_text”:”Invalid access token”,”status”:”error”}}
Respuesta (cuando falta el parámetro del nombre de usuario): {“result”: {“error_text”:”Missing >>username<< parameter”,”status”:”error”}}
Respuesta (cuando el usuario no existe): {“result”: {“error_text”:”Wrong >>username<< parameter”,”status”:”error”}}

¿Tiene una pregunta o una idea? ¡Nosotros podemos ayudarle!

Si tiene alguna pregunta técnica sobre la API, no dude en ponerse en contacto con nuestro Equipo de Soporte.