Webservices HTTP API PlaySMS. Parámetros y Códigos de Retorno
Servicios Web
Este documento explica sobre el protocolo de servicios web de playSMS.
Minimum playSMS versión 1.0-rc5
Acceso
URL de servicios http://[playSMS_domain_or_url]/index.php? : http://[playSMS_domain_or_url]/index.php?app = ws
Ejemplo:
https://playsms.org/trial/index.php?app=ws
Parámetros
En la siguiente tabla se enumeran los parámetros de servicios web para tareas individuales:
|
Nombre | Descripción |
|---|---|
|
h |
token de webservices, configurado por el usuario desde el menú de Preferencias |
|
u |
nombre de usuario |
|
p |
contraseña, suministrada para op = get_token |
|
OP |
operación o tipo de acción |
|
format |
selección de formato de salida |
|
from |
ID de remitente de SMS (para op = pv) |
|
to |
los números de destino, @nombre de usuario o #grupo de código, pueden usar comas |
|
footer |
Pie de página de SMS (para op = pv) |
|
nofooter |
eliminar el pie de página de SMS |
|
msg |
mensaje (+ o% 20 para espacios, urlencode para caracteres no ascii) |
|
schedule |
programar entrega de mensaje, formato: AAAA-MM-DD hh: mm: ss |
|
type |
tipo de mensaje (flash o texto) |
|
Unicode |
si el mensaje es unicode o no (1 = unicode, 0 = no unicode) |
|
queue |
código de cola |
|
src |
número o ID del remitente |
|
dst |
número de destino (número único) |
|
dt |
enviar fecha / hora de SMS |
|
smslog_id |
ID de registro de SMS |
|
last |
último ID de registro de SMS (este número no está incluido en el resultado) |
|
c |
número de estado de entrega que se recuperará |
|
kwd |
Palabras Claves |
|
login_key |
login key sets por admin a través de webservices call op = loginkeyset |
|
query |
servidor de consultas para información útil |
En la tabla siguiente se enumeran los parámetros de los servicios web para las tareas de administración:
| Nombre | Descripción |
|---|---|
| recvnum | número de receptor (para op = inyectar) |
| smsc | SMSC (para op = inyectar) |
| date_* | tareas administrativas relacionadas con los datos suministrados |
Tenga en cuenta que todos los valores deben tener codificación URL.
Códigos de retorno
La siguiente tabla enumera el código de retorno después de una llamada fallida a una operación de servicios web. El funcionamiento correcto devolverá datos correctos en el mensaje de respuesta.
Tenga en cuenta que, de manera predeterminada, el mensaje de respuesta es un mensaje codificado JSON.
|
Código de error | Descripción |
|---|---|
|
Error 100 |
Error de validación: |
|
Error 101 |
el tipo de acción es inválida o desconocida |
|
Error 102 |
uno o más campos vacíos |
|
Error 103 |
no hay suficiente crédito para esta operación |
|
Error 104 |
token de webservice no está disponible |
|
Error 105 |
token de webservice no habilitado para este usuario |
|
Error 106 |
token de servicio web no permitido desde esta dirección IP |
|
Error 200 |
mensaje de envío fallido |
|
Error 201 |
el número o mensaje de destino está vacío |
|
Error 400 |
no hay estado de entrega disponible |
|
Error 401 |
no se ha recuperado el estado de entrega y los SMS aún están en cola |
|
Error 402 |
no se ha recuperado el estado de entrega y SMS se ha procesado desde la cola |
|
Error 500 |
no se devuelven datos o el resultado está vacío |
|
Error 600 |
la autenticación de nivel de administrador falló |
|
Error 601 |
mensaje de inyección fallido |
|
Error 602 |
ID o mensaje del remitente está vacío |
|
Error 603 |
la adición de la cuenta falló debido a la falta de datos |
|
Error 604 |
no agregar cuenta |
|
Error 605 |
se eliminó la cuenta debido a un nombre de usuario desconocido |
|
Error 606 |
no se puede eliminar la cuenta |
|
Error 607 |
el padre del grupo falló debido a un nombre de usuario desconocido |
|
Error 608 |
no se puede establecer el padre |
|
Error 609 |
obtener el padre falló debido a un nombre de usuario desconocido |
|
Error 610 |
no puede obtener el padre |
|
Error 611 |
la prohibición de la cuenta falló debido a un nombre de usuario desconocido |
|
Error 612 |
no puede prohibir la cuenta |
|
Error 613 |
la cuenta no se pudo transferir debido a un nombre de usuario desconocido |
|
Error 614 |
no se puede desbloquear la cuenta |
|
Error 615 |
las preferencias de la cuenta de edición fallaron debido a la falta de datos |
|
Error 616 |
no puede editar las preferencias de la cuenta |
|
Error 617 |
la configuración de la cuenta de edición falló debido a la falta de datos |
|
Error 618 |
no se puede editar la configuración de la cuenta |
|
Error 619 |
el crédito de visualización falló debido a la falta de datos |
|
Error 620 |
no ver crédito |
|
Error 621 |
la adición de crédito falló debido a la falta de datos |
|
Error 622 |
Falla añadir crédito |
|
Error 623 |
la deducción de crédito falló debido a la falta de datos |
|
Error 624 |
no puede deducir el crédito |
|
Error 625 |
la configuración de la clave de inicio de sesión falló debido a la falta de datos |
|
Error 626 |
no se puede configurar la clave de acceso |
Puede que aparezcan nuevos códigos de error en el futuro, debe tener en cuenta que pueden aparecer nuevos códigos en esta sintaxis:
| Código de error | Descripción |
|---|---|
| ERR 1xx | Autores de autenticación o parámetros |
| ERR 2xx | errores específicos de pv |
| ERR 4xx | errores de estado de entrega |
| ERR 5xx | otros |
| ERR 6xx | Tareas Administrativas |
Fuente. Artículo traducido y con muy ligeras modificaciones de: https://github.com/antonraharja/playSMS/blob/master/documents/development/WEBSERVICES.md
