1. Envíos Masivos


La plataforma permite realizar envíos masivos de mensajería a los clientes registrados en ella, para ello existen dos protocolos que pueden ser utilizados para realizar la conexión. A continuación, se detalla la función dichos servicios.

2. Autenticación y Obtención del Token

2.1 Conexión HTTP para Obtención de Token

El servicio web proporcionado atiende una solicitud POST del protocolo HTTP, el cual recibe cadenas JSON y devuelve un resultado en el mismo formato.

A continuación, se muestra la información necesaria para realizar la conexión del servicio.

 

DOMINIO: 

https://api.webhooksms.com

URL: 

[dominio]/authorization-endpoint/v1/api/get/token

METHOD: 

POST 

HEADERS: 

Content-Type: application/json

BODY: 

{ 

"apiKey": [String][required], 

"secret": [String][required]

} 


 

Parámetros  

dominio 

Es la ruta en dónde se encuentra alojado el servicio

Obligatorio 

apiKey 

El ‘apiKey’ es un identificador único para cada cliente, el cual puede ser obtenido directamente desde el portal de WebhookSMS en cualquier momento. Este código es exclusivo y permanente, por lo que, una vez generado, no será necesario volver a crearlo.

Obligatorio 

secret 

Identificador del usuario que es generado en el portal de WebhookSMS. Por seguridad, solo será visible una vez, si es necesario, podrá regenerarse desde el mismo portal.

Obligatorio

 

2.1.1 Ejemplo de Solicitud


{  

    "apiKey": "abcd1234-ef56-gh78-ijkl-9012mnopqrstu-3456vwxyz-7890abcdefg==",  

    "secret": "zxys4567-mnop-8912-abcd-3456qrstuvwx-7890efghij-klmn01234op==" 

}



2.1.2 Códigos de Respuesta


La respuesta entregada por el servicio es una cadena JSON la cual cambiará de acuerdo al tipo de respuesta, para una respuesta exitosa se mostrará como sigue:


Ejemplo de Respuesta Exitosa:


{    "token": "abcd1234ef56gh78ijkl9012mnopqrstu3456vwxyz7890abcdefg1234abcd5678ef90gh12ijkl3456mnop7890qrst1234uvwx5678yzab9012cdef3456ghij7890klmn1234opqr5678stuv9012wxyz3456abcd7890efgh1234ijkl5678mnop9012qrst3456uvwx7890yzab1234cdef5678ghij9012klmn3456opqr7890stuv1234wxyz5678abcd9012efgh3456ijkl7890mnop1234qrst5678uvwx9012yzab3456cdef7890ghij1234klmn5678opqr9012stuv3456wxyz7890abcd1234efgh5678ijkl9012mnop3456qrst7890uvwx1234yzab5678cdef9012ghij3456klmn7890opqr1234stuv5678wy"

}

 

Respuesta exitosa 

token 

El resultado, para el exitoso siempre será un token de acceso. 

abcd1234ef56gh78ijkl9012mnopqrstu3456vwxyz 7890abcdefg1234abcd5678ef90gh12ijkl3456mno p7890qrst1234uvwx5678yzab9012cdef3456ghij7 890klmn1234opqr5678stuv9012wxyz3456abcd7 890efgh1234ijkl5678mnop9012

 

Cuando existe algún problema al procesar la solicitud, la cadena JSON sufrirá algunos cambios, a continuación se muestra la cadena que se recibirá.  

 

Ejemplo respuesta errónea:

{ 

   "error": {

    "status": 500,

    "code": "INTERNAL_SERVER_ERROR",

    "message": "Internal error",

    "messageKey": "api.sms.error.server_error"

    }

}


 Respuesta errónea 

error

Objeto principal que contiene la información sobre el error ocurrido.

  "error": {

    "status": 500,

    "code":      "INTERNAL_SERVER_ERROR",

    "message": "Internal error",

    "messageKey": “api.sms.error.server_error"

    }

status

Indica el código de estado HTTP del error.

500

code 

Código de resultado, de acuerdo con el valor indica el tipo de error ocurrido.

INTERNAL_SERVER_ERROR 

message 

Proporciona una breve descripción del error.

Internal error 

messageKey 

Clave que se utiliza para proporcionar un mensaje de error localizado o más detallado.

api.sms.error.server_error 

 


2.1.3 Códigos de Error para Obtención de Token

A continuación se muestra el catálogo de errores que puede regresar la plataforma. 


Código (errorCode)

Identificador de tipo (message)

Mensaje (hint)

1

Validation error

Internal server error