REST SMS API v.2 del desarrollador para comunicarse con el Portal de Enlace SMS
Este documento proporciona una referencia para todas las funciones disponibles a través de la interfaz HTTP para enviar SMS.
La API de HTTP te permite integrar su aplicación (cliente) al (portal) de SMSCenter.gr utilizando el protocolo HTTP para enviar SMS.
Info General
El cliente envía una solicitud GET HTTP a la interfaz HTTP de SMSCenter.gr al suministrar una lista de parámetros necesarios. SMSCenter.gr emite de vuelta una respuesta HTTP que indica el éxito de la operación
Ten en cuenta que el delimitador utilizado para el status de la llamada API a continuación en datos devueltos, '|', es el carácter de barra vertical (ASCII 124).
Todos los parámetros pasados debe ser codificados en URL y también en UTF-8, tal como se describe en los siguientes ejemplos de código.
Formato de respuestas API
La API responde a todas las llamadas de acuerdo con el parámetro tipo. Los valores aceptados para el parámetrotipo son => v2 que es el valor por defecto, json y xml.
Ejemplo de respuestas para llamada a lakey/get de la API =>
URL: https://static.smscenter.gr/api/key/get?username=[username]&password=[password]&type=...
...&type=v2
Responde:
6fe2dd9c06df83
...&type=json
Responde:
{
"status" : "1",
"key" : "6fe2dd9c06df83",
"remarks" : "Success"
}
...&type=xml
Responde:
<response>
<status>1</status>
<key>6fe2dd9c06ff83</key>
<remarks>Success</remarks>
</response>
Prúebalo (key/get)
https://static.smscenter.gr/api/key/get?username=&password=&type=
Los comandos disponibles en la v.2 de la API de SMSCenter.gr se muestran a continuación.
API Key
La Clave de la API se debe utilizar en lugar del nombre de usuario y contraseña para todas las llamadas a la API. Puede seguir utilizando los parámetros de nombre de usuario y contraseña, pero se recomienda el uso de la Clave API por razones de seguridad.
Tú adquieres tu Clave API usando la llamada de key/get y lo utiliza para todas las llamadas a la API en lugar de los parámetros de usuario y contraseña. Si necesitas cambiar la Clave API, puedes hacerlo mediante la llamada de key/reset.
Las llamadas de key/get y key/reset son las únicas que requieren el uso de nombre de usuario y contraseña.
Una vez que obtienes tu Clave API puedes usarla para las otras llamadas de API.
Prúebalo (key/get)
https://static.smscenter.gr/api/key/get?username=&password=&type=
Prúebalo (key/reset)
https://static.smscenter.gr/api/key/reset?username=&password=&type=
Devolución
...&type=v2
Responde:
6fe2dd9c06df83
...&type=json
Responde:
{
"status" : "1",
"key" : "6fe2dd9c06df83",
"remarks" : "Success"
}
...&type=xml
Responde:
<response>
<status>1</status>
<key>6fe2dd9c06ff83</key>
<remarks>Success</remarks>
</response>
Enviando SMS
URL: https://static.smscenter.gr/api/sms/send?key=[API Key]
Parámetros aceptados
| Parámetro | Descripción | Presencia |
|---|---|---|
text |
Mensaje que se enviará. Debe ser codificado en URL. | Requerido |
to |
MSIDSN del destinatario del mensaje que será enviado. Ej => 49175123456 | Requerido |
from |
ID del Remitente (Si es alfanumérico, máx 11 caracteres, o máx 16 dígitos numéricos) | Opcional |
flash |
Activar envío de Flash SMS | Opcional |
ucs |
Activar el envío de SMS utilizando codificación UCS | Opcional |
timestamp |
Establecer la fecha y la hora al estilo Unix Epoch para enviar el SMS | Opcional |
type |
Tipo de respuesta API, puede ser v2, json o xml |
Opcional |
Devoluciones
...&type=v2
Responde:
1234567890
...&type=json
Responde:
{
"status" : "1",
"id" : "1234567890",
"balance" : "1234",
"remarks" : "Success"
}
...&type=xml
Responde:
<response>
<status>1</status>
<id>1234567890</id>
<balance>1234</balance>
<remarks>Success</remarks>
</response>
| Descripción | |
|---|---|
código de resultado |
1 para el mensaje enviado, de lo contrario envío fallido |
sms_id |
el número de ID de mensaje (o 0 si no se envió). Los reportes de entrega se dan en los ID del mensaje |
saldo |
el saldo de la cuenta |
remarks |
Notas sobre la llamada |
Prúebalo (sms/send)
https://static.smscenter.gr/api/sms/send?key=&to=&from=&text=Hello&type=