Api SMS para desarrolladores

API de desarrolladores

Con nuestra API RESTFul, puede integrar rápida y fácilmente nuestros servicios en cualquier sistema de terceros o desarrollar aplicaciones increíbles.

Andaon SMS es una plataforma de SMS de alta calidad que le permite integrar cualquiera de sus aplicaciones con nuestro sistema de envío y recepción de mensajes. La principal ventaja de nuestro sistema es su simplicidad de implementación. El mensaje SMS puede tener el nombre de su empresa o cualquier número de teléfono que posea como nombre del remitente. Cada mensaje enviado desde nuestro sistema tiene su propia identificación única que le permite recibir su confirmación de entrega.

Autenticación API

Se requiere autenticación de usuario para interactuar con nuestro punto final de API. La autenticación se realiza pasando su API Key y API Token como parte del cuerpo de su solicitud

Solicitud de autenticación de muestra

https://sms1.andaon.com/smsAPI?apikey=Your_API_KEY&apitoken=YOUR_API_TOKEN

Envío de un mensaje (individual o masivo)

Punto final de API: https://sms1.andaon.com/smsAPI?sendsms
Método de solicitud: POST o GET

Solicitud de muestra

https://sms1.andaon.com/smsAPI?sendsms&apikey=Your_API_KEY&apitoken=YOUR_API_TOKEN&type=sms&from=SENDERID&to=123456&text=My+first+text&scheduledate=2018-04-24 12:25:23

Parámetros

apikey : su clave de API única (obligatorio)
apitoken : su token de API único (obligatorio)
tipo : Tipo de mensaje Ej. sms, voz, unicode, flash, mms, whatsapp (el valor predeterminado es sms) (obligatorio)
de : Su ID de remitente (obligatorio)
a : Lista separada por comas de números de destino (incluido el código de país) (obligatorio)
texto : el texto de su mensaje (codificado en URL) (obligatorio)
archivo : URL del archivo de voz (para mensaje de voz) o URL del archivo multimedia (para mms o mensaje de whatsapp) (opcional)
scheduledate : fecha y hora para enviar el mensaje (AAAA-MM-DD HH: mm: ss) (opcional)
duración : duración de su mensaje de voz en segundos (requerido para voz)

Ejemplo de respuesta satisfactoria (JSON)

    {
                            "request": "sendsms",
                            "status": "queued",
                            "group_id": "1234",
                            "date": "2018-04-24 12:25:23"
                        }

Ejemplo de respuesta de error (JSON)

  {
                            "request": "sendsms",
                            "status": "error",
                            "message": "Sender ID not allowed"
                        }

Verificar el estado del mensaje

Punto final de la API: https://sms1.andaon.com/smsAPI?groupstatus
Método de solicitud: POST o GET

Solicitud de muestra

https://sms1.andaon.com/smsAPI?groupstatus&apikey=Your_API_KEY&apitoken=YOUR_API_TOKEN&groupid=1234

Parámetros

apikey : su clave de API única (obligatorio)
apitoken : su token de API único (obligatorio)
groupid : el group_id devuelto por la solicitud de sendms (obligatorio)

Ejemplo de respuesta satisfactoria (JSON)

 {
                            "request": "groupstatus",
                            "status": "success",
                            "group_id": "1234",
                            "group_status": "sent",
                            "recipients": [
                                {
                                    "id": "21",
                                    "to": "231235433",
                                    "status": "failed"
                                },
                                {
                                    "id": "22",
                                    "to": "4471235433",
                                    "status": "sent"
                                },
                                {
                                    "id": "25",
                                    "to": "1871235433",
                                    "status": "queued"
                                }
                            ],
                            "date": "2018-04-24 12:25:23"
                        }

Respuesta de error de muestra (JSON)

{
                            "request": "groupstatus",
                            "status": "error",
                            "message": "Error message",
                        }

Obteniendo bandeja de entrada de mensajes

API End-point: https://sms1.andaon.com/smsAPI?getinbox
Método de solicitud:GET

Solicitud de muestra

https://sms1.andaon.com/smsAPI?getinbox&apikey=Your_API_KEY&apitoken=YOUR_API_TOKEN&list=unread

Parámetros

apikey: Your unique API Key (necesaria)
apitoken: tu token API único(necesaria)
: «todos» devolverá todos los mensajes, mientras que «no leídos» devolverá solo los mensajes no leídos (el valor predeterminado es no leído)(Opcional)

Ejemplo de respuesta de éxito (JSON)

{
                            "request": "getinbox",
                            "status": "success",
                            "inbox": [
                                {
                                    "id": "12",
                                    "from": "123456789",
                                    "to": "2347015272",
                                    "message": "Hi. This is message 1",
                                    "date": "2018-04-24 12:25:23"
                                },
                                {
                                    "id": "26",
                                    "from": "447882892",
                                    "to": "2347015272",
                                    "message": "Hi again. This is message 2",
                                    "date": "2018-04-24 12:25:23"
                                }
                           ]
                        }

Ejemplo de respuesta de error (JSON)

{
                            "request": "getinbox",
                            "status": "error",
                            "message": "Error",
                        }

Obteniendo bandeja de entrada de mensajes

Punto final de API: https://sms1.andaon.com/smsAPI?getinbox
Método de solicitud: GET

Solicitud de muestra

https://sms1.andaon.com/smsAPI?getinbox&apikey=Your_API_KEY&apitoken=YOUR_API_TOKEN&list=unread

Parámetros

apikey: su clave de API única (obligatorio)
apitoken: su token de API único (obligatorio)
lista: «todos» devolverá todos los mensajes mientras que «no leídos» devolverá solo los mensajes no leídos (el valor predeterminado es no leído) (opcional)

Ejemplo de respuesta satisfactoria (JSON)

 {
                            "balance": "12345"
                        }

Ejemplo de respuesta de error (JSON)

                        {
                            "request": "getinbox",
                            "estado": "error",
                            "mensaje": "Error",
                        }

Verificar saldo de crédito

Punto final de API: https://sms1.andaon.com/smsAPI?balance
Método de solicitud: GET

Solicitud de muestra

https://sms1.andaon.com/smsAPI?balance&apikey=Your_API_KEY&apitoken=YOUR_API_TOKEN

Parámetros

apikey : su clave de API única (obligatorio)
apitoken : su token de API único (obligatorio)

Ejemplo de respuesta satisfactoria (JSON)

                        {
                            "balance": "12345"
                        }

Ejemplo de respuesta de error (JSON)

{
                            "request": "balance",
                            "status": "error",
                            "message": "Invalid user",
                        }

Crear canal de Whatsapp

Punto final de la API: https://sms1.andaon.com/smsAPI?createchannel
Método de solicitud: POST o GET

Solicitud de muestra

https://sms1.andaon.com/smsAPI?createchannel&apikey=Your_API_KEY&apitoken=YOUR_API_TOKEN&label=My+First+Channel&plan=starter

Parámetros

apikey : su clave de API única (obligatorio)
apitoken : su token de API único (obligatorio)
etiqueta : la etiqueta que se utilizará para su nuevo canal (obligatorio)
plan : el paquete de facturación para tu nuevo canal. Por ejemplo, principiante, comercial, profesional o empresarial ( consulte los paquetes y precios de Whatsapp ) (obligatorio)

Ejemplo de respuesta satisfactoria (JSON)

{
                            "request": "createchannel",
                            "status": "success",
                            "channel_id": "53583gd693dg93tdg923gd2reo",
                            "gateway_id": "123",
                            "subscription_end": "2018-04-24 12:25:23"
                        }

Ejemplo de respuesta de error (JSON)

{
                            "request": "createchannel",
                            "status": "error",
                            "message": "Error message",
                        }

Lista de canales de Whatsapp

Punto final de la API: https://sms1.andaon.com/smsAPI?listchannel
Método de solicitud: POST o GET

Solicitud de muestra

https://sms1.andaon.com/smsAPI?listchannel&apikey=Your_API_KEY&apitoken=YOUR_API_TOKEN

Parámetros

apikey : su clave de API única (obligatorio)
apitoken : su token de API único (obligatorio)

Ejemplo de respuesta satisfactoria (JSON)

{
                            "request": "listchannel",
                            "status": "success",
                            "channels": [
                                {
                                    "channel_id": "53583gd693dg93tdg923gd2reo",
                            		"gateway_id": "123",
                                    "whatsapp_number": "123456789",
                                    "label": "My First Channel",
                                    "last_sync": "2019-04-24 12:25:23"
                                },
                                {
                                    "channel_id": "61fg68d6f3dg83tggr78gd2c7h",
                            		"gateway_id": "456",
                                    "whatsapp_number": "123556789",
                                    "label": "My Other Channel",
                                    "last_sync": "2019-06-14 12:25:23"
                                }
                           ]
                            "channel_count": "2"
                        }

Ejemplo de respuesta de error (JSON)

                        {
                            "request": "listchannel",
                            "estado": "error",
                            "message": "Mensaje de error",
                        }

Escanear código QR

Punto final API: https://sms1.andaon.com/smsAPI?scanqr
Método de solicitud: POST o GET

Solicitud de muestra

https://sms1.andaon.com/smsAPI?scanqr&apikey=Your_API_KEY&apitoken=YOUR_API_TOKEN&channel_id=3zsbvwe63bd7630gd37db

Parámetros

apikey : su clave de API única (obligatorio)
apitoken : su token de API único (obligatorio)
channel_id : el ID del canal genera una imagen QR de escaneo (requerido)

Ejemplo de respuesta satisfactoria (código de imagen Base-64)

      Imagen codificada en base 64 que muestra la imagen QR generada por whatsapp

Ejemplo de respuesta de error (JSON)

{
                            "request": "scanqr",
                            "status": "error",
                            "message": "Error message",
                        }

Ver detalles del canal

Punto final de la API: https://sms1.andaon.com/smsAPI?viewchannel
Método de solicitud: POST o GET

Solicitud de muestra

https://sms1.andaon.com/smsAPI?viewchannel&apikey=Your_API_KEY&apitoken=YOUR_API_TOKEN&channel_id=3639t3g337g3bf3fg730f

Parámetros

apikey : su clave de API única (obligatorio)
apitoken : su token de API único (obligatorio)
channel_id : el ID del canal para ver (requerido)

Ejemplo de respuesta satisfactoria (JSON)

{
                            "request": "viewchannel",
                            "status": "success",
                            "channel_id": "3639t3g337g3bf3fg730f",
                            "gateway_id": "123",
                            "plan": "pro",
                            "whatsapp_number": "123456789",
                            "whatsapp_version": "1289",
                            "label": "My First Channel",
                            "last_sync": "2019-04-24 12:25:23"
                            "device_status": "session active",
                            "up_time": "2:04:44"
                        }

Ejemplo de respuesta de error (JSON)

{
                            "request": "viewchannel",
                            "status": "error",
                            "message": "Error message",
                        }

Borrar la cola de mensajes del canal

Punto final de la API: https://sms1.andaon.com/smsAPI?clearqueue
Método de solicitud: POST o GET

Solicitud de muestra

https://sms1.andaon.com/smsAPI?clearqueue&apikey=Your_API_KEY&apitoken=YOUR_API_TOKEN&channel_id=3639t3g337g3bf3fg730f

Parámetros

apikey : su clave de API única (obligatorio)
apitoken : su token de API único (obligatorio)
channel_id : el ID del canal para borrar la cola (obligatorio)

Ejemplo de respuesta satisfactoria (JSON)

{
                            "request": "clearqueue",
                            "status": "success",
                            "channel_id": "3639t3g337g3bf3fg730f",
                            "queue_count": "0"
                        }

Ejemplo de respuesta de error (JSON)

{
                            "request": "clearqueue",
                            "status": "error",
                            "message": "Error message",
                        }

Restablecer canal

Punto final de la API: https://sms1.andaon.com/smsAPI?resetchannel
Método de solicitud: POST o GET

Solicitud de muestra

https://sms1.andaon.com/smsAPI?resetchannel&apikey=Your_API_KEY&apitoken=YOUR_API_TOKEN&channel_id=3639t3g337g3bf3fg730f

Parámetros

apikey : su clave de API única (obligatorio)
apitoken : su token de API único (obligatorio)
channel_id : el ID del canal para restablecer (requerido)

Ejemplo de respuesta satisfactoria (JSON)

{
                            "request": "resetchannel",
                            "status": "success",
                            "channel_id": "3639t3g337g3bf3fg730f",
                        }

Ejemplo de respuesta de error (JSON)

{
                            "request": "resetchannel",
                            "status": "error",
                            "message": "Error message",
                        }

Eliminar canal

Punto final de la API: https://sms1.andaon.com/smsAPI?deletechannel
Método de solicitud: POST o GET

Solicitud de muestra

https://sms1.andaon.com/smsAPI?deletechannel&apikey=Your_API_KEY&apitoken=YOUR_API_TOKEN&channel_id=3639t3g337g3bf3fg730f

Parámetros

apikey : su clave de API única (obligatorio)
apitoken : su token de API único (obligatorio)
channel_id : el ID del canal que se va a eliminar (obligatorio)

Ejemplo de respuesta satisfactoria (JSON)

{
                            "request": "deletechannel",
                            "status": "success",
                            "channel_id": "3639t3g337g3bf3fg730f",
                        }

Ejemplo de respuesta de error (JSON)

 {
                            "request": "deletechannel",
                            "status": "error",
                            "message": "Error message",
                        }

API de desarrolladores

Autenticación API

Envío de un mensaje (individual o masivo)

Verificar el estado del mensaje

Obteniendo bandeja de entrada de mensajes

Obteniendo bandeja de entrada de mensajes

Verificar saldo de crédito

Crear canal de Whatsapp

Lista de canales de Whatsapp

Escanear código QR

Ver detalles del canal

Borrar la cola de mensajes del canal

Restablecer canal

Eliminar canal

Andaon es una plataforma que te ofrece una forma rápida, sencilla y económica de crear tu propia app móvil sin conocimientos de programación ,enviar campañas de mensajes de texto, enviar campañas de email marketing ,una suite completa de marketing social.

Servicios

Informacion

Empresa

Top Sliding Bar

Recent Tweets

Join Our Newsletter Today On The Writers Cookbook