ReferenciaS API
Aproveche todas las ventajas de nuestra plataforma, con los productos relacionados se puede obtener el máximo provecho y así conseguir de mejor manera cumplir con su tarea del día.
Descripción
Este método crea mensajes (SMS/Correos).
Métodos de petición disponibles
Tipo | Método | URL |
---|---|---|
SOAP | POST | https://cloud.greyphillips.com/apis/soap/wolf/communicator.asmx?op=setMessage |
REST | POST | https://commcenter.greyphillips.com/apis/rest/thanos/Message |
Parámetros
Campo | Descripción | Tipo de dato | Obligatoria | Adicionales |
---|---|---|---|---|
strToken | Es el token de seguridad. | String | X | |
strType | Corresponde al tipo de mensaje que se desea mandar enviar. | String | Valores que puede recibir:
|
|
strSubType | String | Valores que puede recibir en caso de ser EMAIL:
Valores que puede recibir en caso de ser SMS:
|
||
strDatetime | Es la fecha que se debe enviar el mensaje. | String | Debe ser en formato de texto universal para fechas. Ejemplo: YYYYMMDD HHmmss
|
|
strTo | Es el número/correo del destinatario. | String | Este valor corresponde a la cuenta de correo o el número de teléfono celular según sea el caso indicado en strType. Para el caso de envíos de correos electrónicos, este valor debe corresponder a los estándares relacionados a la estructura correcta en las cuentas de correo, para el caso de los números de teléfono, este debe corresponder a la estructura de país y numero, por ejemplo, 50660591516, es decir, Costa Rica, al número 60591516. |
|
strSubject | Es el asunto del mensaje. | String | ||
strMessage | Es el cuerpo del mensaje. | String | ||
intPriority | Es el cuerpo del mensaje. | Integer | Valores que puede recibir:
|
|
strContactID | Es el identificador del contacto. | String | Es un valor opcional. | |
strAttachFilesIDs | Es el identificador de archivos que existen en el sistema. | String | Estos son los valores generados en la función SetUploadFiletoDB, solo los valores generados de esta función son válidos. | |
strCampaignID | Es el identificador de la campaña. | String | Permite agrupar un conjunto de mensajes, se obtiene desde la interfaz de la plataforma, corresponde a un GUID. | |
strSMTPAccountID | Este valor es la llave de identificación de la cuenta que desea usarse para hacer el envío, estas cuentas se crean en el panel de control de la PSI. | String | ||
strFromAppID | Este valor sirve para indicar el aplicativo que está haciendo el registro del mensaje, es de libre asignación. | String | X | Longitud máxima: 36 carácteres de longitud. |
strTableRef | Nombre de la tabla con la cual se relaciona el mensaje. | String | X | El mensaje puede estar relacionado con otra tabla de la base de datos, por ejemplo: Tareas. |
strRefID | Es el identificador del registro en la tabla brindada en el campo strTableRef. | String | X | Por ejemplo: se indicó en el campo strTableRef el valor Tareas, y en el campo strRefID el valor XYZ, entonces el sistema va a saber que el mensaje está relacionado con la tabla Tareas y específicamente con el registro que posea el identificador XYZ. |
Respuesta (200)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<setMessageResponse xmlns="http://greyphillips.com/">
<setMessageResult>string</setMessageResult>
</setMessageResponse>
</soap:Body>
</soap:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<setMessageResponse xmlns="http://greyphillips.com/">
<setMessageResult>string</setMessageResult>
</setMessageResponse>
</soap12:Body>
</soap12:Envelope>
Ejemplo de enviar SMS en .NET:
Es una solución desarrollada en Visual Studio 2017, dentro tiene dos proyectos. Uno desarrollado en Visual Basic y hace uso de los servicios web mediante SOAP y el otro proyecto está desarrollado en C# y consume el servicio web mediante REST.