A continuación se describen los enpoints expuestos mediante nuestra API, para el consumo e interacción con nuestro sistema de mensajería y notificaciones.
\nPara la llamada del API, debe reemplazar el parametro {{API}} por https://connectivasms.com/api/v1
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"14561068","collectionId":"75feaae3-4ac2-4051-b94a-09e3ac4f9139","publishedId":"2sA3XS9fUm","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-06-17T06:49:15.000Z"},"item":[{"name":"auth","item":[{"name":"token","id":"8c6e3820-e0b3-4712-9c69-75ccb168bc2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": \"\",\n \"secret\" : \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{API}}/auth/token","description":"La petición debe ir acompañada en formato JSON, conteniendo los datos Client y Secret. El sistema retornará una respuesta de éxito o error, según sean las crdenciales sean correctas o no. Ejemplo de respuesta:
\n{\"token\": \"2|C8paCGxzohZzKzDjqKneHFFaSES4HrWqmb7KPRyNf5956513\"}
En las posteriores peticiones, siempre debe incluirse en el header de la petición
\nAuthentication Bearer token.
\n","urlObject":{"path":["auth","token"],"host":["{{API}}"],"query":[],"variable":[]}},"response":[{"id":"03b28139-5b03-424b-9bd8-2dc52a974cee","name":"token","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"key\": \"\",\n \"secret\" : \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{API}}/auth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.2.19"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 17 Jun 2024 07:00:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"2|C8paCGxzohZzKzDjqKneHFFaSES4HrWqmb7KPRyNf5956513\"\n}"}],"_postman_id":"8c6e3820-e0b3-4712-9c69-75ccb168bc2b"}],"id":"db01bf70-f597-448e-81af-d4aa8e756233","description":"Para consumir los recursos del API es necesario solicitar un token de acceso, mediante las credenciales obtenidas en el proceso de registro de una nueva API Key.
\n","_postman_id":"db01bf70-f597-448e-81af-d4aa8e756233"},{"name":"audiencia","item":[{"name":"index","id":"07dabe71-7e93-4158-bcbe-4678ca9727fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Al realizar la solicitud, obtendremos un arreglo de objetos conformados por los contactos que hemos agreado.
\n","urlObject":{"path":["audience"],"host":["{{API}}"],"query":[],"variable":[]}},"response":[{"id":"67eb1079-1561-49cc-ba79-428dfc3f8925","name":"index","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{API}}/audience"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 06 Jul 2024 23:05:42 GMT"},{"key":"Server","value":"Apache/2.4.52 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"name\": \"Juarez Peres\",\n \"phone\": \"+52123456874\",\n \"status\": 1\n },\n {\n \"id\": 14,\n \"name\": \"Raul Mazias\",\n \"phone\": \"+5215241876641\",\n \"status\": 1\n },\n {\n \"id\": 15,\n \"name\": \"Manuel Aguilar\",\n \"phone\": \"+521524187664\",\n \"status\": 1\n },\n {\n \"id\": 16,\n \"name\": \"Francisco Robles\",\n \"phone\": \"+5278451425474\",\n \"status\": 1\n }\n]"}],"_postman_id":"07dabe71-7e93-4158-bcbe-4678ca9727fd"},{"name":"create","id":"abfa2a0e-360f-45dd-ad2b-1739ce5c9a3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Para crear un nuevo contacto debemos enviar una petición con un objeto JSON, conformado por la estructura de ejemplo:
\n","urlObject":{"path":["audience"],"host":["{{API}}"],"query":[],"variable":[]}},"response":[{"id":"ca3ea53e-5d99-4a78-9d90-c6bce8e6b090","name":"create","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Jose Manuel\",\n \"phone\": \"521124022794\",\n \"email\": \"customer@dominio.com\",\n \"status\": 0\n}","options":{"raw":{"language":"json"}}},"url":"{{API}}/audience"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 06 Jul 2024 23:35:54 GMT"},{"key":"Server","value":"Apache/2.4.52 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"err\": false,\n \"message\": \"Datos registrados correctamente.\",\n \"data\": {\n \"name\": \"Jose Manuel\",\n \"phone\": \"521124022794\",\n \"email\": \"customer@dominio.com\",\n \"status\": 0,\n \"updated_at\": \"2024-07-06T23:35:54.000000Z\",\n \"created_at\": \"2024-07-06T23:35:54.000000Z\",\n \"id\": 19\n }\n}"}],"_postman_id":"abfa2a0e-360f-45dd-ad2b-1739ce5c9a3b"},{"name":"update","id":"bf884463-97e8-4219-9f25-02b9f265830b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Para actualizar un registro bastará con:
\n","urlObject":{"path":["audience","18"],"host":["{{API}}"],"query":[],"variable":[]}},"response":[{"id":"85a29d4c-4abc-4dcd-98fb-69b40e0336ee","name":"update","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Jose Manuel Aguilar\",\n \"phone\": \"521124022791\",\n \"email\": \"customer@dominio.com\",\n \"status\": 0\n}","options":{"raw":{"language":"json"}}},"url":"{{API}}/audience/18"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 06 Jul 2024 23:22:19 GMT"},{"key":"Server","value":"Apache/2.4.52 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"err\": false,\n \"message\": \"Datos actualizados correctamente.\",\n \"data\": {\n \"id\": 18,\n \"name\": \"Jose Manuel Aguilar\",\n \"phone\": \"521124022791\",\n \"email\": \"customer@dominio.com\",\n \"status\": 0,\n \"created_at\": \"2024-07-06T23:13:31.000000Z\",\n \"updated_at\": \"2024-07-06T23:22:03.000000Z\"\n }\n}"}],"_postman_id":"bf884463-97e8-4219-9f25-02b9f265830b"},{"name":"delete","id":"501a5241-bbae-46ed-8fe4-6e27ecaa2ddd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"El módulo de audiencia. En éste módulo recidirán el grupo de contactos que deseamos gestionar. Los datos que componen el registro son los siguientes:
\n","_postman_id":"75af7faa-5b91-4231-9082-ca3dd1cf3203"},{"name":"agrupaciones","item":[{"name":"index","id":"d3b99add-a11d-4ac4-a2c8-3e976752e8f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"El enpoint retornará una lista de los grupos creados, con sus detalles de información.
\n","urlObject":{"path":["groups"],"host":["{{API}}"],"query":[],"variable":[]}},"response":[{"id":"33168751-fc6d-4712-bdca-5c8246b35d2d","name":"index","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{API}}/groups"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 06 Jul 2024 23:29:43 GMT"},{"key":"Server","value":"Apache/2.4.52 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"name\": \"Comitiva residencial Col1\",\n \"status\": 1\n }\n]"}],"_postman_id":"d3b99add-a11d-4ac4-a2c8-3e976752e8f9"},{"name":"create","id":"e206689f-06ac-4398-9d80-fb09d3801daf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Para crear un nuevo grupo se requieren los siguientes parámetros:
\nname: string con un máximo de 254 caracteres.
\nstatus: integer los valores están restringidos a 0 para inactivo y 1 para activo.
\nPara actualizar un grupo, debemos pasar mediante la url el id del registro a actualizar, considerando que los parámetros que conforman el objeto JSON son los siguientes:
\nname: string con un máximo de 254 caracteres.
\nstatus: integer los valores están restringidos a 0 para inactivo y 1 para activo.
\nPara eliminar un registro, debemos pasar el parámetro id en la url de la petición.
\n","urlObject":{"path":["groups","3"],"host":["{{API}}"],"query":[],"variable":[]}},"response":[{"id":"2f37e21d-0349-4230-a05c-dfb9c14dd858","name":"delete","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Invitacion\",\n \"status\": 1\n}","options":{"raw":{"language":"json"}}},"url":"{{API}}/groups/3"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.2.19"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 17 Jun 2024 07:22:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"err\": false,\n \"message\": \"Registro eliminado correctamente.\"\n}"}],"_postman_id":"ec03d472-c409-439c-85a5-44ea553a201d"}],"id":"26216b97-aaa6-4480-a959-515bd8ce5111","description":"El módulo de grupos ayudará a crear grupos de contactos para el envío de notificaciones; por ejemplo, a un grupo de amigos para una reunión de cumpleaños o un grupo de contactos de consejo vecinal.
\n","_postman_id":"26216b97-aaa6-4480-a959-515bd8ce5111"},{"name":"campañas","item":[{"name":"index","id":"2e41a9b9-15f8-4e42-9c1f-d65016ba5996","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Para crear una campaña, deberemos especificar los siguientes parámetros dentro de un objeto JSON.
\nLos parámetros que debemos indicar son los siguientes:
\nname: Obligatorio, indica el nombre que tendrá la campaña.
\ndescription: Obligatorio, indica una descripción de referencia de nuestra campaña.
\nstart_date: Obligatorio, indicará la fecha de inicio de la campaña. El formato de fecha deberá ser: yyyy-mm-dd hh:mm:ss.
\nen_date: Obligatorio, indicará la fecha de inicio de la campaña. El formato de fecha deberá ser: yyyy-mm-dd hh:mm:ss.
\nsms: Obligatorio, indicará si utilizaremos el canal de envío de SMS. Los valores asignables son los siguientes:
\n1 - Cuando deseamos utilizar este canal.
\n0 - Cuando no utilizaremos este canal.
\nemail: Obligatorio, indicará si utilizaremos el canal de envío de email. Los valores asignables son los siguientes:
\n1 - Cuando deseamos utilizar este canal.
\n0 - Cuando no utilizaremos este canal.
\nWhatsApp: Obligatorio, indicará si utilizaremos el canal de envio de WhatsApp. Los valores asignables son los siguientes:
\n1 - Cuando deseamos utilizar este canal.
\n0 - Cuando no deseamos utilizar este canal.
\nestatus: Obligatorio, Indica el estado de la campaña. Los valores pueden ser los siguientes:
\n1 - Activa
\n0 - Inactiva
\nPara actualizar una campaña, deberemos especificar los siguientes parámetros dentro de un objeto JSON.
\nLos parámetros que debemos indicar son los siguientes:
\nname: Obligatorio, indica el nombre que tendrá la campaña.
\ndescription: Obligatorio, indica una descripción de referencia de nuestra campaña a crear.
\nstart_date: Obligatorio, indicará la fecha de inicio de la campaña. El formato de fecha deberá ser: yyyy-mm-dd hh:mm:ss.
\nen_date: Obligatorio, indicará la fecha de inicio de la campaña. El formato de fecha deberá ser: yyyy-mm-dd hh:mm:ss.
\nsms: Obligatorio, indicará si utilizaremos el canal de envío de SMS. Los valores asignables son los siguientes:
\n1 - Cuando deseamos utilizar este canal.
\n0 - Cuando no utilizaremos este canal.
\nemail: Obligatorio, indicará si utilizaremos el canal de envío de email. Los valores asignables son los siguientes:
\n1 - Cuando deseamos utilizar este canal.
\n0 - Cuando no utilizaremos este canal.
\nWhatsApp: Obligatorio, indicará si utilizaremos el canal de envío de WhatsApp. Los valores asignables son los siguientes:
\n1 - Cuando deseamos utilizar este canal.
\n0 - Cuando no deseamos utilizar este canal.
\nestatus: Obligatorio, Indica el estado de la campaña. Los valores pueden ser los siguientes:
\n1 - Activa
\n0 - Inactiva
\nPara eliminar una campaña debemos realizar un reques de tipo delete y especificar, en el último parámetro de la url, el id de nuestra campaña a eliminar.
\n","urlObject":{"path":["campains","16"],"host":["{{API}}"],"query":[],"variable":[]}},"response":[{"id":"ff504387-dabb-497f-9a59-af77436acb1d","name":"delete","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{API}}/campains/16"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 07 Jul 2024 00:45:29 GMT"},{"key":"Server","value":"Apache/2.4.52 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"err\": false,\n \"message\": \"Registro eliminado correctamente.\"\n}"}],"_postman_id":"ed8f8e36-19c1-4190-9592-363223f5557f"}],"id":"088bf413-0020-40b5-adfb-ff3456f6d94f","description":"Las campañas son agrupaciones de mensajes. Podremos especificar, en cada mensaje, que canales de comunicación serán utilizados. Deberemos especificar los canales de comunicación, las fechas de inicio y finalización de la campaña.
\n","_postman_id":"088bf413-0020-40b5-adfb-ff3456f6d94f"},{"name":"camapaña & mensajes","item":[{"name":"index","id":"ad03a831-e59c-458b-900a-86ffa7c9a4c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Al consultar los mensajes de tipo campaña debe pasarse como parte de los parámetros, a modo de prefijo, el id del la campaña. En el ejemplo, el parámetro indicativo de la campaña sera el 2.
\n","urlObject":{"path":["campain-messages","13"],"host":["{{API}}"],"query":[],"variable":[]}},"response":[{"id":"150d49fa-7d8d-4423-b37c-59844ea7025d","name":"index","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{API}}/campain-messages/13"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 06 Jul 2024 23:52:56 GMT"},{"key":"Server","value":"Apache/2.4.52 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"campain_id\": 13,\n \"group_id\": 1,\n \"title\": \"Hola\",\n \"message\": \"Hola\",\n \"sms\": 0,\n \"whatsapp\": 0,\n \"email\": 0,\n \"start\": \"2024-07-06\",\n \"end\": \"2024-07-07\",\n \"status\": 1\n }\n]"}],"_postman_id":"ad03a831-e59c-458b-900a-86ffa7c9a4c4"},{"name":"create","id":"46555f14-dcac-4f06-be6d-c594a606afd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Al crear un mensaje según el objeto JSON descrito, se programará según el rango de fechas elegido en los canales de difusión seleccionados, ya sean sms, WhatsApp o email.
\nLos parámetros que componen el objeto JSON son los siguientes:
\ncampain_id: Obligatorio, indica el id de la campaña a la cual pertenece el mensaje que deseamos enviar.
\ngroup_id: Obligatorio, indica el id del grupo de audiencia a los que se enviarán las notificaciones y/o mensajes.
\ntitle: Obligatorio, indica el título que tendrá el mensaje cuando sea creado.
\nmessage: Obligatorio, deberá contener el mensaje, notificación o comunicado que deseamos enviar.
\nsms: Obligatorio, indica si utilizaremos este canal de comunicación. Los valores pueden ser los siguientes:
\n1 - El canal será utilizado
\n0 - No será utilizado
\nemail: Obligatorio, indica si utilizaremos este canal de comunicación. Los valores pueden ser los siguientes:
\n1 - El canal será utilizado
\n0 - No será utilizado
\nWhatsApp: Obligatorio, indica si utilizaremos este canal de comunicación. Los valores pueden ser los siguientes:
\n1 - El canal será utilizado
\n0 - No será utilizado
\nstart: Obligatorio, indica a partir de que fecha deberán empezarse a distribuir los mensajes y/o notificaciones. El formato de fecha deberá ser la siguiente: yyyy-mm-dd.
\nend: Obligatorio, indica a partir de que fecha deberán empezar a distribuirse los mensajes y/o notificaciones. El formato de fecha deberá ser la siguiente: yyyy-mm-dd.
\nstatus: Obligatorio, indica el estatus del mensaje. En este sentido los valores pueden ser los siguientes:
\n1 - Activo
\n0 - Inactivo
\nPara editar un mensaje de campaña, deben ajustarse los parámetros del objeto. Al realizar esta acción se deberá tener en cuenta que el sistema reenviará todos los mensajes con la nueva información, eliminando los existentes; por lo que si un usuario ha recibido un notificación, la volverá a recibir con la correccion realizada. En el caso, de los canales de comunicación, que no sean ilimitados, lo anterior provocará un nuevo cargo en los servicios.
\nLos parámetros que componen el objeto JSON son los siguientes:
\ncampain_id: Obligatorio, indica el id de la campaña a la cual pertenece el mensaje que deseamos enviar.
\ngroup_id: Obligatorio, indica el id del grupo de audiencia a los que se enviarán las notificaciones y/o mensajes.
\ntitle: Obligatorio, indica el título que tendrá el mensaje cuando sea creado.
\nmessage: Obligatorio, deberá contener el mensaje, notificación o comunicado que deseamos enviar.
\nsms: Obligatorio, indica si utilizaremos este canal de comunicación, los valores pueden ser los siguientes:
\n1 - El canal será utilizado
\n0 - No será utilizado
\nemail: Obligatorio, indica si utilizaremos este canal de comunicación, los valores pueden ser los siguientes:
\n1 - El canal será utilizado
\n0 - No será utilizado
\nWhatsApp: Obligatorio, indica si utilizaremos este canal de comunicación, los valores pueden ser los siguientes:
\n1 - El canal será utilizado
\n0 - No será utilizado
\nstart: Obligatorio, indica a partir de que fecha deberán empezar a distribuirse los mensajes y/o notificaciones. El formato de fecha deberá ser la siguiente: yyyy-mm-dd.
\nend: Obligatorio, indica a partir de que fecha deberán empezar a distribuirse los mensajes y/o notificaciones. El formato de fecha deberá ser la siguiente: yyyy-mm-dd.
\nstatus: Obligatorio, indica el estatus del mensaje. En este sentido los valores pueden ser los siguientes:
\n1 - Activo
\n0 - Inactivo
\nAl eliminar un mensaje de formato campaña, todos los mensajes relacionados serán borrados del sistema interrumpiendo la difusión de los mismos; excepto aquellos que ya se encuentren en proceso de difusión.
\n","urlObject":{"path":["campain-messages","18"],"host":["{{API}}"],"query":[],"variable":[]}},"response":[{"id":"17bbc076-b4e0-4b2f-b146-061ccfd8f009","name":"delete","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{API}}/campain-messages/18"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 07 Jul 2024 00:43:50 GMT"},{"key":"Server","value":"Apache/2.4.52 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"err\": false,\n \"message\": \"Registro eliminado correctamente.\"\n}"}],"_postman_id":"d8948040-5bda-40cc-89ac-79da3e679dcc"}],"id":"4c75563f-75fd-484c-bf46-d5273cf0c1e0","description":"Los mensajes de tipo campaña serán emitidos a todos los contactos en la agrupación elegida, según el canal elegido en la configuración.
\n","_postman_id":"4c75563f-75fd-484c-bf46-d5273cf0c1e0"},{"name":"mensajes","item":[{"name":"emails","item":[{"name":"index","id":"082be53e-a21a-456b-ae39-5a16ca5f2592","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Al consultar el enpoint retornará un arreglo de objetos de los mensajes que han sido creados, ya sea medianet el módulo de campañas o directos.
\n","urlObject":{"path":["emails"],"host":["{{API}}"],"query":[],"variable":[]}},"response":[{"id":"5937e288-09c3-48b7-a98b-fa316de29c63","name":"index","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{API}}/emails"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 07 Jul 2024 00:50:28 GMT"},{"key":"Server","value":"Apache/2.4.52 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 83,\n \"campain_message_id\": 0,\n \"campain_id\": 0,\n \"receipt\": \"example@example.com\",\n \"message\": \"Hello\",\n \"send_at\": null,\n \"status\": 0,\n \"retries\": 0\n },\n {\n \"id\": 112,\n \"campain_message_id\": 0,\n \"campain_id\": 0,\n \"receipt\": \"example@example.com\",\n \"message\": \"Factura de cierre de mes.\",\n \"send_at\": \"2024-06-15 16:39:38\",\n \"status\": 0,\n \"retries\": 0\n }\n]"}],"_postman_id":"082be53e-a21a-456b-ae39-5a16ca5f2592"},{"name":"create","id":"6d2b5aa4-e66d-4fd7-8471-96da4e8bb3e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Para crear un mensaje, necesitaremos enviar los siguientes datos:
\ncampain_id: Opcional, representa el ID de la campaña a la cual deseamos que el mensaje sume estadística.
\ncampain_message_id: Opcional, representa el ID del mensaje contenido en una campaña y que deseamos que se sume a la estadística.
\nreceipt: Obligatorio, represeta la dirección de email del contacto al cual deseamos enviar el mensaje, notificacion, etc.
\nmessage: Obligatorio, contiene el mensaje que deseamos enviar al destinatario
\nsend_at: Obligatorio, indica cuando debe enviarse el mensaje o notificación. En caso de que la fecha sea anterior, el mensaje será enviado inmediatamente. La zona horaria, a tener en cuenta, es UTC o GMT.
\nstatus: representa el estatus en el que se encuentra el mensaje. Este valor es gestionado por el sistema:
\n0 - Pendiente
\n1 - Enviando
\n2 - Enviado
\n3 - Error (no ha sido posible enviar)
\nretries: Obligatorio, número de reintentos a realizar de envío.
\nPara editar un mensaje email necesitaremos pasar como parámetro de id del mensaje y enviar los siguientes datos, según sea necesario:
\ncampain_message_id: Opcional, representa el ID del mensaje de la campaña al cual deseamos el mensaje sume la estadística.
\ncampain_id: Opcional, representa el ID de la campaña a la cual deseamos el mensaje sume estadística.
\nreceipt: Obligatorio, represeta la dirección de email del contacto al cual deseamos enviar el mensaje, notificacion, etc.
\nmessage: Obligatorio, contiene el mensaje que deseamos enviar al destinatario
\nsend_at: Obligatorio, indica cuando debe enviarse el mensaje o notificación. En caso de que la fecha sea anterior el mensaje será enviado inmediatamente. La zona a considerar es UTC o GMT.
\nstatus: representa el estatus en el que se encuentra el mensaje. Este valor es gestionado por el sistema:
\n0 - Pendiente
\n1 - Enviando
\n2 - Enviado
\n3 - Error(No ha sido posivle enviar)
\nretries: Obligatorio, número de reintentos a realizar de envío.
\nPara eliminar un mensaje, debemos enviar una request de tipo DELETE con el id como parametro final de la url. En caso de no existir el recurso, retornará un mensaje indicando que no ha sido encontrado.
\n","urlObject":{"path":["emails","227"],"host":["{{API}}"],"query":[],"variable":[]}},"response":[{"id":"442c5ed6-3eeb-4f06-8233-68c67dca400b","name":"delete","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{API}}/emails/227"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 07 Jul 2024 01:02:28 GMT"},{"key":"Server","value":"Apache/2.4.52 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"err\": false,\n \"message\": \"Registro eliminado correctamente.\"\n}"}],"_postman_id":"89936f15-dbaf-4e48-9e14-a1fcb39b9fd2"}],"id":"7fe07f83-c73f-4c75-9c3a-7159def794ed","description":"El módulo de emails es útil para envío de notificaciones o marketing, mediante correo eletrónico.
\nHaga envíos Programados, estableciendo la fecha y hora de difusión. En caso de que la fecha de emisión sea anterior a la actual, el email será puesto en proceso lo antes posible. Sebe considerarse la zona horaria UTC o GMT.
\nSi se desea colocar un email en directo para su envio y éste sea contemplado en alguna campaña, deberá indicarse en el parámetro correspondiente, tanto de la campaña como de la subcampaña.
\n","_postman_id":"7fe07f83-c73f-4c75-9c3a-7159def794ed"},{"name":"Whatsapp","item":[{"name":"index","id":"954a6829-6d17-4ea7-8822-fb3719efdce9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Al consultar el enpoint, retornará un arreglo de objetos de los mensajes que han sido creados, ya sea mediante el módulo de campañas o directos de tipo WhatsApp.
\n","urlObject":{"path":["whatsapp"],"host":["{{API}}"],"query":[],"variable":[]}},"response":[{"id":"73b67b9c-143d-495e-bf53-997cd26d1279","name":"index","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{API}}/whatsapp"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 07 Jul 2024 03:09:24 GMT"},{"key":"Server","value":"Apache/2.4.52 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 254,\n \"device_id\": 0,\n \"campain_message_id\": 0,\n \"campain_id\": 0,\n \"receipt\": \"+521144778844\",\n \"message\": \"Necesito una copia del documento que se envio en la reunion de hoy\",\n \"send_at\": \"2024-07-06 19:25:39\",\n \"status\": 1,\n \"retries\": 0\n },\n {\n \"id\": 255,\n \"device_id\": 20,\n \"campain_message_id\": 0,\n \"campain_id\": 0,\n \"receipt\": \"+521144778844\",\n \"message\": \"Necesito una copia del documento que se envio en la reunion de hoy\",\n \"send_at\": \"2024-07-06 19:25:39\",\n \"status\": 2,\n \"retries\": 0\n },\n {\n \"id\": 256,\n \"device_id\": 0,\n \"campain_message_id\": 0,\n \"campain_id\": 0,\n \"receipt\": \"+521144778844\",\n \"message\": \"Necesito una copia del documento que se envio en la reunion de hoy\",\n \"send_at\": \"2024-07-06 19:29:39\",\n \"status\": 1,\n \"retries\": 0\n },\n {\n \"id\": 257,\n \"device_id\": 0,\n \"campain_message_id\": 0,\n \"campain_id\": 0,\n \"receipt\": \"+521144778844\",\n \"message\": \"Necesito una copia del documento que se envio en la reunion de hoy\",\n \"send_at\": \"2024-07-06 19:35:39\",\n \"status\": 3,\n \"retries\": 0\n },\n {\n \"id\": 258,\n \"device_id\": 0,\n \"campain_message_id\": 0,\n \"campain_id\": 0,\n \"receipt\": \"+521144778844\",\n \"message\": \"Necesito una copia del documento que se envio en la reunion de hoy\",\n \"send_at\": \"2024-07-06 19:38:10\",\n \"status\": 3,\n \"retries\": 0\n },\n {\n \"id\": 259,\n \"device_id\": 0,\n \"campain_message_id\": 0,\n \"campain_id\": 0,\n \"receipt\": \"+521144778844\",\n \"message\": \"Necesito una copia del documento que se envio en la reunion de hoy\",\n \"send_at\": \"2024-07-06 19:40:00\",\n \"status\": 2,\n \"retries\": 0\n },\n {\n \"id\": 260,\n \"device_id\": 20,\n \"campain_message_id\": 0,\n \"campain_id\": 0,\n \"receipt\": \"+521144778844\",\n \"message\": \"Necesito una copia del documento que se envio en la reunion de hoy\",\n \"send_at\": \"2024-07-06 19:40:00\",\n \"status\": 2,\n \"retries\": 3\n },\n {\n \"id\": 261,\n \"device_id\": 20,\n \"campain_message_id\": 0,\n \"campain_id\": 0,\n \"receipt\": \"+521144778844\",\n \"message\": \"Necesito una copia del documento que se envio en la reunion de hoy\",\n \"send_at\": \"2024-07-06 19:40:00\",\n \"status\": 2,\n \"retries\": 3\n }\n]"}],"_postman_id":"954a6829-6d17-4ea7-8822-fb3719efdce9"},{"name":"create","id":"53c899dd-e9f1-4ce7-8ae8-944d910e1dbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Para crear un mensaje, necesitaremos enviar los siguientes datos:
\nNota:
\nEn caso de asignar el valor predeterminada \"0\" en device_id y contar con una o más cuentas de WhatsApp, el sistema asignará, de forma aletaria, una de ellas.
\ncampain_message_id: Opcional, representa el ID del mensaje, de la campaña, que deseamos sume la estadística.
\ncampain_id: Opcional, representa el ID de la campaña a la cual deseamos el mensaje sume estadística.
\nreceipt: Obligatorio, represeta el número de contacto al cual deseamos enviar el mensaje, notificacion, etc. Los valores pueden ser:
\nNúmero de teléfono.
\nDirección de correo eletrónico.
\nmessage: Obligatorio, contiene el mensaje que deseamos enviar al destinatario.
\nfiles: Opcional, para enviar archivos, que acompañen el mensaje, es necesario colocar un arreglo bajo la siguiente estructura:
\nname: nombre del archivo (no aparecerá en el mensaje).
\ntype: define el tipo de codificación del documento. Pueden ser los siguientes tipos:
\nbase64
\nurl
\ncontent: debe contener, ya sea el documento codificado en base64 o url. Es importante saber que, los límites de documentos, serán los mismos que aplica WhatsApp al momento de hacer envíos desde la aplicación.
\nsend_at: Obligatorio, indica cuando debe enviarse el mensaje o notificación. En caso de que la fecha sea anterior, el mensaje será enviado inmediatamente. Se tomará en cuenta la zona UTC o GMT.
\nstatus: No requerido, representa el estatus inicial del mensaje. Este puede ser los siguientes valores:
\n0 - Pendiente
\n1 - Enviando
\n2 - Enviado
\n3 - Error (no ha sido posivle enviar)
\nretries: Obligatorio, número de reintentos a realizar de envíos.
\nPara editar un mensaje, necesitaremos pasar como parámetros de id del mensaje y enviar los siguientes datos según sea necesario:
\nNota:
\nEn caso de asignar el valor predeterminada \"0\" en device_id y contar con una o más cuentas de WhatsApp, el sistema asignará, de forma aletaria, una de ellas.
\ncampain_message_id: Opcional, representa el ID del mensaje de la campaña al cual deseamos el mensaje sume la estadística.
\ncampain_id: Opcional, representa el ID de la campaña a la cual deseamos el mensaje sume estadística.
\nreceipt: Obligatorio, represeta el número de contacto al cual deseamos enviar el mensaje, notificacion, etc. Los valores pueden ser:
\nNúmero de teléfono.
\nDirección de correo eletrónico.
\nmessage: Obligatorio, contiene el mensaje que deseamos enviar al destinatario.
\nfiles: Opcional, para enviar archivos, que acompañen el mensaje, es necesario colocar un arreglo bajo la siguiente estructura:
\nname: nombre del archivo (no aparecerá en el mensaje).
\ntype: define el tipo de codificación del documento. Pueden ser los siguientes tipos:
\nbase64
\nurl
\ncontent: debe contener, ya sea el documento codificado en base64 ó url. Es importante saber que los límites de documentos, serán los mismos que aplica WhatsApp al momento de enviarlos desde la aplicación.
\nsend_at: Obligatorio, indica cuando debe enviarse el mensaje o notificación. En caso de que la fecha sea anterior el mensaje será enviado inmediatamente. Se tomará en cuanta la zona UTC o GMT.
\nstatus: No requerido, representa el estatus del mensaje. Estos pueden ser los siguientes valores:
\n0 - Pendiente
\n1 - Enviando
\n2 - Enviado
\n3 - Error (no ha sido posivle enviar)
\nretries: Obligatorio, número de reintentos a realizar de envio.
\nPara eliminar un mensaje, debemos enviar una request de tipo DELETE con el id como parametro final de la url. En caso de no existir el recurso, retornará un mensaje indicando que no ha sido encontrado.
\n","urlObject":{"path":["whatsapp","262"],"host":["{{API}}"],"query":[],"variable":[]}},"response":[{"id":"5486e4ed-737a-408a-bfda-eaf6e6cec4a9","name":"delete","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{API}}/whatsapp/262"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 07 Jul 2024 02:57:57 GMT"},{"key":"Server","value":"Apache/2.4.52 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"err\": false,\n \"message\": \"Registro eliminado correctamente.\"\n}"}],"_postman_id":"8ba360a8-5501-4275-bd09-b04d2dd30ad6"}],"id":"f5a11aac-0be2-4ec6-99cd-373a24439dfb","description":"El módulo de mensajes/WhatsApp es útil para envío de notificaciones o marketing mediante mensajes WhatsApp. El tamaño máximo de caracteres, para un mensaje de WhatsApp, será de 65,000 caracteres.
\nNo empleamos un API Oficial de WhatsApp, por lo que es necesario tome precauciones para evitar ser considerado un spam y su cuenta sea suspendida. Esto sucede, principalmente, porque los contactos a los cuales envia no han tenido interacción previa o le han marcado como spam previamente.
\n","_postman_id":"f5a11aac-0be2-4ec6-99cd-373a24439dfb"},{"name":"sms","item":[{"name":"index","id":"4d51d2dc-4b56-4671-96d1-1c578f1e7e4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Al consultar el enpoint retornará un arreglo de objetos de los mensajes que han sido creados, ya sea mediante el módulo de campañas o directos de tipo sms.
\n","urlObject":{"path":["sms"],"host":["{{API}}"],"query":[],"variable":[]}},"response":[{"id":"b9d2cd62-eefa-4ffd-a902-3cb66db51564","name":"index","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://wmessages.wuitoonchi.com/sms"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 07 Jul 2024 03:09:24 GMT"},{"key":"Server","value":"Apache/2.4.52 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 254,\n \"device_id\": 0,\n \"campain_message_id\": 0,\n \"campain_id\": 0,\n \"receipt\": \"+521144778844\",\n \"message\": \"Necesito una copia del documento que se envio en la reunion de hoy\",\n \"send_at\": \"2024-07-06 19:25:39\",\n \"status\": 1,\n \"retries\": 0\n },\n {\n \"id\": 255,\n \"device_id\": 20,\n \"campain_message_id\": 0,\n \"campain_id\": 0,\n \"receipt\": \"+521144778844\",\n \"message\": \"Necesito una copia del documento que se envio en la reunion de hoy\",\n \"send_at\": \"2024-07-06 19:25:39\",\n \"status\": 2,\n \"retries\": 0\n },\n {\n \"id\": 256,\n \"device_id\": 0,\n \"campain_message_id\": 0,\n \"campain_id\": 0,\n \"receipt\": \"+521144778844\",\n \"message\": \"Necesito una copia del documento que se envio en la reunion de hoy\",\n \"send_at\": \"2024-07-06 19:29:39\",\n \"status\": 1,\n \"retries\": 0\n },\n {\n \"id\": 257,\n \"device_id\": 0,\n \"campain_message_id\": 0,\n \"campain_id\": 0,\n \"receipt\": \"+521144778844\",\n \"message\": \"Necesito una copia del documento que se envio en la reunion de hoy\",\n \"send_at\": \"2024-07-06 19:35:39\",\n \"status\": 3,\n \"retries\": 0\n },\n {\n \"id\": 258,\n \"device_id\": 0,\n \"campain_message_id\": 0,\n \"campain_id\": 0,\n \"receipt\": \"+521144778844\",\n \"message\": \"Necesito una copia del documento que se envio en la reunion de hoy\",\n \"send_at\": \"2024-07-06 19:38:10\",\n \"status\": 3,\n \"retries\": 0\n },\n {\n \"id\": 259,\n \"device_id\": 0,\n \"campain_message_id\": 0,\n \"campain_id\": 0,\n \"receipt\": \"+521144778844\",\n \"message\": \"Necesito una copia del documento que se envio en la reunion de hoy\",\n \"send_at\": \"2024-07-06 19:40:00\",\n \"status\": 2,\n \"retries\": 0\n },\n {\n \"id\": 260,\n \"device_id\": 20,\n \"campain_message_id\": 0,\n \"campain_id\": 0,\n \"receipt\": \"+521144778844\",\n \"message\": \"Necesito una copia del documento que se envio en la reunion de hoy\",\n \"send_at\": \"2024-07-06 19:40:00\",\n \"status\": 2,\n \"retries\": 3\n },\n {\n \"id\": 261,\n \"device_id\": 20,\n \"campain_message_id\": 0,\n \"campain_id\": 0,\n \"receipt\": \"+521144778844\",\n \"message\": \"Necesito una copia del documento que se envio en la reunion de hoy\",\n \"send_at\": \"2024-07-06 19:40:00\",\n \"status\": 2,\n \"retries\": 3\n }\n]"}],"_postman_id":"4d51d2dc-4b56-4671-96d1-1c578f1e7e4f"},{"name":"create","id":"5280a756-aa69-4705-b8df-8e964bddd9bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Para crear un mensaje, necesitaremos enviar los siguientes datos:
\nNota:
\nDebe considerar que de no especifica el valor de device_id el sistema utilizara el saldo de su plan SMS para enviar el mensaje.
\nEn caso de asignar el valor predeterminada \"0\" en device_id y contar con una o más dispositivos SMS, el sistema asignará, de forma aletaria, uno de ellos.
\ncampain_message_id: Opcional, representa el ID del mensaje de la campaña al cual deseamos el mensaje sume la estadística.
\ncampain_id: Opcional, Representa el ID de la campaña a la cual deseamos el mensaje sume estadística.
\nreceipt: Obligatorio, represeta el número de contacto al cual deseamos enviar el mensaje, notificación, etc. Los valores pueden ser:
\nNúmero de teléfono.
\nDirección de correo eletrónico.
\nmessage: Obligatorio, contiene el mensaje que deseamos enviar al destinatario.
\nsend_at: Obligatorio, indica cuando debe enviarse el mensaje o notificación. En caso de que la fecha sea anterior, el mensaje será enviado inmediatamente. La zona horaria, a considerar, será UTC o GMT.
\nstatus: No requerido, representa el estatus inicial del mensaje. Este puede ser los siguientes valores:
\n0 - Pendiente
\n1 - Enviando
\n2 - Enviado
\n3 - Error (no ha sido posible enviar)
\nretries: Obligatorio, número de reintentos a realizar de envío.
\nEl módulo de mensajes/sms es útil para envío de notificaciones o marketing, mediante mensajería sms con un porcentaje de entrega del 95%.
\nEl tamaño máximo por mensaje es de 160 caracteres para el estandar GSM y 70 para Unicode, como emojis, acentos, etc. Si envía un mensaje con más longitud, este será mandado por partes.
\nNota:
\nSi al momento del envío, usted no cuenta con el saldo requerido, los mensajes se truncarán hasta alcanzar el máximo disponible.
\n","_postman_id":"c5ae2454-4fcb-45dc-91c5-def302a50023"},{"name":"index","id":"e0c7e4e4-afab-49a9-93ad-04d2cef8aa5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Al consultar el enpoint, retornará un arreglo de objetos de los mensajes que han sido creados; ya sea medianet el módulo de campañas o directos.
\n","urlObject":{"path":["messages"],"host":["{{API}}"],"query":[],"variable":[]}},"response":[{"id":"4ce01003-e64d-453e-9167-5de1a42f0977","name":"index","originalRequest":{"method":"GET","header":[],"url":"{{API}}/messages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.2.19"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 17 Jun 2024 17:35:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 46,\n \"device_id\": 0,\n \"type\": 1,\n \"campain_message_id\": 0,\n \"campain_id\": 0,\n \"receipt\": \"+52112233554\",\n \"message\": \"Message\",\n \"send_at\": \"2024-06-15 16:39:38\",\n \"status\": 1,\n \"retries\": 0\n },\n {\n \"id\": 47,\n \"device_id\": 0,\n \"type\": 1,\n \"campain_message_id\": 0,\n \"campain_id\": 0,\n \"receipt\": \"+52112233554\",\n \"message\": \"Message\",\n \"send_at\": \"2024-06-15 16:39:38\",\n \"status\": 1,\n \"retries\": 0\n }\n]"}],"_postman_id":"e0c7e4e4-afab-49a9-93ad-04d2cef8aa5b"},{"name":"create","id":"622bb77c-a5a4-4b97-b835-613df2fe7d0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Para crear un mensaje, necesitaremos enviar los siguientes datos:
\ndevice_id: Obligatorio, el dispositivo mediante el cual deseamos enviar el mensaje, ID del dispositivo SMS ó ID Cuenta de WhatsApp
\ntype: Obligatorio, el tipo de canal de envío. Pueden ser los siguientes valores:
\n1 - SMS (mensajes cortos)
\n2 - Email
\n3 - WhatsApp
\ncampain_message_id: Opcional, representa el ID del mensaje de la campaña al cual deseamos el mensaje sume la estadística.
\ncampain_id: Opcional, representa el ID de la campaña a la cual deseamos el mensaje sume estadística.
\nreceipt: Obligatorio, represeta el número de contactos al cual deseamos enviar el mensaje, notificacion, etc. Los valores pueden ser:
\nNúmero de teléfono.
\nDirección de correo eletrónico.
\nmessage: Obligatorio, contiene el mensaje que deseamos enviar al destinatario
\nfiles: Opcional, para enviar archivos, que acompañen el mensaje, es nesario colocar un arreglo bajo la siguiente estructura:
\nname: Nombre del archivo (no aparecerá en el mensaje).
\ntype: Define el tipo de codificación del documento. Puede ser de los siguientes tipos:
\nbase64
\nurl
\ncontent: debe contener el documento codificado en base64 ó url. Es importante saber, que los límites de documentos, serán los mismos que aplica WhatsApp al momento de enviar desde la aplicación.
\nsend_at: Obligatorio, indica cuando debe enviarse el mensaje o notificación, en caso de que la fecha sea anterior el mensaje será enviado inmediatamente. La zona horaria, a considerar, será UTC o GMT.
\nstatus: Obligatorio, representa el estatus inicial del mensaje. Este puede ser los siguientes valores:
\n0 - No procesado
\n1 - Enviado
\n2 - Error (no ha sido posivle enviar)
\nretries: Obligatorio, número de reintentos a realizar de envio.
\nPara editar un mensaje, necesitaremos pasar como parámetro de id del mensaje y enviar los siguientes datos según sea necesario:
\ndevice_id: Obligatorio, el dispositivo mediante el cual deseamos enviar el mensaje, ID del dispositivo SMS ó ID Cuenta de WhatsApp.
\ntype: Obligatorio, el tipo de canal de envio. Pueden ser los siguientes valores:
\n1 - SMS (mensajes cortos)
\n2 - Email
\n3 - WhatsApp
\ncampain_message_id: Opcional, representa el ID del mensaje de la campaña al cual deseamos el mensaje sume la estadística.
\ncampain_id: Opcional, representa el ID de la campaña a la cual deseamos el mensaje sume estadística.
\nreceipt: Obligatorio, represeta el número de contactos al cual deseamos enviar el mensaje, notificacion, etc. Los valores pueden ser:
\nNúmero de teléfono.
\nDirección de correo eletrónico.
\nmessage: Obligatorio, contiene el mensaje que deseamos enviar al destinatario.
\nfiles: Opcional, para enviar archivos que acompañen el mensaje, es necesario colocar un arreglo bajo la siguiente estructura:
\nname: Obligatorio, nombre del archivo (no aparecerá en el mensaje).
\ntype: Obligatorio, define el tipo de codificacion del documento. Pueden ser los siguientes tipos:
\nbase64
\nurl
\ncontent: Obligatorio, debe contener el documento codificado en base64 ó url. Es importante saber que, los limites de documentos, serán los mismos que aplica WhatsApp al momento de enviar desde la aplicación.
\nsend_at: Obligatorio, indica cuando debe enviarse el mensaje o notificación. En caso de que la fecha sea anterior, el mensaje será enviado inmediatamente. La zona horaria, a tomar en cuanta, es UTP o GMT.
\nstatus: Obligatorio, representa el estatus inicial del mensaje, este puede ser los siguientes valores:
\n0 - No procesado
\n1 - Enviado
\n2 - Error (no ha sido posivle enviar)
\nretries: Obligatorio, número de reintentos a realizar de envio.
\nPara eliminar un mensaje, debemos enviar una request de tipo DELETE con el id como parametro final de la url, en caso de no existir el recurso retornara un mensaje indicando que no ha sido encontrado.
\n","urlObject":{"path":["messages","45"],"host":["{{API}}"],"query":[],"variable":[]}},"response":[{"id":"3d1e8c68-e11d-48e1-91c6-a5f9f1663e0f","name":"delete","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Invitacion\",\n \"status\": 1\n}","options":{"raw":{"language":"json"}}},"url":"{{API}}/messages/48"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.2.19"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 17 Jun 2024 17:38:55 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"err\": false,\n \"message\": \"Registro eliminado correctamente.\",\n \"data\": {\n \"id\": 48,\n \"device_id\": 0,\n \"type\": 1,\n \"campain_message_id\": 0,\n \"campain_id\": 0,\n \"receipt\": \"+52112233554\",\n \"message\": \"Reunión Acueros internos\",\n \"send_at\": \"2024-06-15 16:39:38\",\n \"status\": 1,\n \"retries\": 0\n }\n}"}],"_postman_id":"60a83e1a-699f-41b8-ab29-cf66c06cea69"}],"id":"83044189-0c7f-4627-887a-7646261d04d2","description":"El módulo de mensajes es útil para envío de notificaciones directas sin tiempos de espera. Sin embargo, es posible establecer la fecha y hora de difución para programar una notificacion. En caso de que la fecha de emisión sea posterior a la actual, el mensaje será puesto en proceso lo antes posible. La zona horaria, a considerar es UTC o GMT.
\nSi se desea colocar un mensaje en directo para su envío y éste sea contemplado en alguna campaña, deberá indicarse en el parámetro correspondiente.
\n","_postman_id":"83044189-0c7f-4627-887a-7646261d04d2"},{"name":"Servicio 2FA/OTP","item":[{"name":"request","id":"569a121d-93ac-4c97-b6dc-999a503c159e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Al realizar una peticion al servicio 2FA el destinatario recibirá un código de 5 digitos valido por 5 minutos y de uso unico tambien conocido como OTP.
\nPara utilizar el servicio 2FA debe indicar los parametros que se describen acontinuación.
\nPara validar el código recibido, es necesario enviar una peticion que contenga el campo code con el codigo recibido, asi mismo debe ser en formato json.
\n","urlObject":{"path":["2fa","check"],"host":["{{API}}"],"query":[],"variable":[]}},"response":[{"id":"14612093-ccbf-4a23-b169-dff3bec1084a","name":"check","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"code\": \"63065\"\n}","options":{"raw":{"language":"json"}}},"url":"{{API}}/2fa/check"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 22 Jul 2024 02:47:22 GMT"},{"key":"Server","value":"Apache/2.4.52 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"err\": false,\n \"message\": \"Codigo 2FA verificado correctamente.\"\n}"}],"_postman_id":"ed1b3597-9977-4cfa-ad50-75e22f8cdea8"}],"id":"ddb7790c-8d07-4a03-8de3-c70058359e3c","description":"La autenticación en dos fases (2FA) es un método de seguridad de administración de identidad y acceso que requiere dos formas de identificación para acceder a los recursos y los datos.
\nAgrega una capa de seguridad a tus sistemas utilizando nuestro servicio 2FA, has llegar al usuario el código de uso unico tambien llamado OTP mediante SMS o WhatsApp.
\n","_postman_id":"ddb7790c-8d07-4a03-8de3-c70058359e3c"}]}