Documentación API de integración Dinama/Mobisa
\n\n\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"3895335","collectionId":"c6beeeab-9d89-4f65-8acd-8cb329d22f85","publishedId":"2s8YzMXkQa","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-12-04T14:48:10.000Z"},"item":[{"name":"Integración JSON (Opción Recomendada)","id":"6595c34d-ff5b-47e5-853e-b98db0cadb46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"content-type","value":"application/json","description":"
Content Type del tipo de formato. Siempre application/json
\n"},{"key":"x-api-key","value":"TaluCLg2Ri9JovkeVtKZS9feS82SaneG66y64eOF","description":"API Key asignado por Dinama/Mobisa para autorizar el uso del servicio
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"notify\",\n \"serviceSID\": \"VE-Practipush\",\n \"recipient\": \"584100000000\",\n \"message\": \"Prueba de Envio\"\n}"},"url":"https://api.dinama.com/services/messages?countryCod=Cliente solicitud:
\n\n{\n \"type\":\"notify\",\n \"serviceSID\":\"<Información entregada por Dinama/Mobisa>\",\n \"recipient\":\"<Número de teléfono que va a recibir la notificación\n en formato internacional>\",\n \"message\":\"<Mensaje a enviar (notificación)>\",\n \"messageId\":\"<(opcional) Código alfanumérico de identificación de este mensaje. \n Esta informacion es requerida para solicitar el estado\n del envío (acuse de recibo)>\", \n \"transactionId\":\"<(opcional) ID de Transacción>\",\n \"memo\":\"<(opcional) Categoria asociada al mensaje (para efectos de reportes)>\",\n \"sendDate\":\"<opcional) Fecha/Hora (formato yyyymmddHHMMss) para indicar cuándo se debe \n enviar el mensaje. \n La fecha no puede ser superior a 3 días en el futuro \n (default: envío inmediato)>\",\n \"requestDeliveryStatus\":<(opcional) true para solicitar status del envío, \n false no solicitar status del envío \n (default false)>,\n \"allowConcat\": < true: Para autorizar el uso de mensajes segmentados(concatenados) y \n codificación UCS2(UTF16) para envío de mensajes de longitud \n mayor a 160 y/o con caracteres acentuados y/o emoticones \n * Ver Términos y condiciones que aplica si el valor es true (sección 7)\n false: Para recortar el texto de mensajes de mas de 160 caracteres\n (los caracteres acentuados y/o emoticones no se van a visualizar \n en el móvil) \n (default: false)\n > \n}\nDinama/Mobisa respuesta:
\n\n{\n \"type\":\"ack\",\n \"errorCode\":<Id numérico con el status de la solicitud \n (0: solicitud procesada, \n Otro número: Solicitud fallida)\n (ver sección 6. Códigos de error)>,\n \"errorDescription\":\"<Mensaje con la descripción del código de error>\"\n}\nEsta opción permite enviar multiples mensajes en una sola invocación
\n\n\nRestricciones:
\n
\nTamaño máximo del payload JSON: 6 MB
\nCantidad máxima de notificaciones a enviar por cada invocación: 10,000
Cliente solicitud:
\n\n{\n \"type\":\"notifyBatch\",\n \"serviceSID\":\"<Información entregada por Dinama/Mobisa>\",\n \"messages\": [\n {\"recipient\":\"<Número de teléfono que va a recibir la notificación\n en formato internacional>\",\n \"message\":\"<Mensaje a enviar (notificación)>\",\n \"messageId\":\"<(opcional) Código alfanumérico de identificación de este mensaje. \n Esta informacion es requerida para solicitar el estado\n del envío (acuse de recibo)>\"\n }, \n\n ...\n {\"recipient\":\"<Número de teléfono que va a recibir la notificación\n en formato internacional>\",\n \"message\":\"<Mensaje a enviar (notificación)>\",\n \"messageId\":\"<(opcional) Código alfanumérico de identificación de este mensaje. \n Esta informacion es requerida para solicitar el estado\n del envío (acuse de recibo)>\", \n }\n ], \n \"transactionId\":\"<(opcional) ID de Transacción>\",\n \"memo\":\"<(opcional) Categoria asociada al mensaje (para efectos de reportes)>\",\n \"sendDate\":\"<opcional) Fecha/Hora (formato yyyymmddHHMMss) para indicar cuándo se debe \n enviar el mensaje. \n La fecha no puede ser superior a 3 días en el futuro \n (default: envío inmediato)>\",\n \"requestDeliveryStatus\":<(opcional) true para solicitar status del envío, \n false no solicitar status del envío \n (default false)>,\n \"allowConcat\": < true: Para autorizar el uso de mensajes segmentados(concatenados) y \n codificación UCS2(UTF16) para envío de mensajes de longitud \n mayor a 160 y/o con caracteres acentuados y/o emoticones \n * Ver Términos y condiciones que aplica si el valor es true (sección 7)\n false: Para recortar el texto de mensajes de mas de 160 caracteres\n (los caracteres acentuados y/o emoticones no se van a visualizar \n en el móvil) \n (default: false)\n > \n}\nDinama/Mobisa respuesta:
\n\n{\n \"type\":\"ack\",\n \"errorCode\":<Id numérico con el status de la solicitud \n (0: solicitud procesada, \n Otro número: Solicitud fallida)\n (ver sección 6. Códigos de error)>,\n \"errorDescription\":\"<Mensaje con la descripción del código de error>\"\n}\nDinama/Mobisa solicitud (se invoca el URL configurado por el cliente para enviar el JSON):
\n\n{\n \"type\":\"request\", \n \"serviceSID\":\"<Información entregada por Dinama/Mobisa>\",\n \"sender\":\"<Número de teléfono del suscriptor en formato internacional (sin el signo de +)>\",\n \"message\":\"<Mensaje enviado por el suscriptor>\",\n \"transactionId\":\"<(opcional) ID de Transacción>\",\n}\nCliente respuesta:
\n\n{\n \"type\":\"ack\",\n \"errorCode\":<Id numérico con el status de la solicitud \n (0: solicitud procesada, \n Otro número: Solicitud fallida)\n (ver sección 6. Códigos de error)>,\n \"errorDescription\":\"<Mensaje con la descripción del código de error>\"\n}\nCliente solicitud:
\n\n{\n \"type\":\"response\", \n \"serviceSID\":\"<Información entregada por Dinama/Mobisa>\",\n \"recipient\":\"<Número de teléfono del suscriptor en formato internacional (sin el signo de +)>\",\n \"recipient\":\"<Número de teléfono que va a recibir la notificación\n en formato internacional>\",\n \"messageId\":\"<(opcional) Código alfanumérico de identificación de este mensaje. \n Esta informacion es requerida para solicitar el estado\n del envío (acuse de recibo)>\", \n \"transactionId\":\"<(opcional) ID de Transacción>\",\n \"memo\":\"<(opcional) Categoria asociada al mensaje (para efectos de reportes)>\",\n \"requestDeliveryStatus\":<(opcional) true para solicitar status del envío, \n false no solicitar status del envío \n (default false)>,\n \"allowConcat\": < true: Para autorizar el uso de mensajes segmentados(concatenados) y \n codificación UCS2(UTF16) para envío de mensajes de longitud \n mayor a 160 y/o con caracteres acentuados y/o emoticones \n * Ver Términos y condiciones que aplica si el valor es true (sección 7)\n false: Para recortar el texto de mensajes de mas de 160 caracteres\n (los caracteres acentuados y/o emoticones no se van a visualizar \n en el móvil) \n (default: false)\n > \n}\n\n \nDinama/Mobisa respuesta:
\n\n{\n \"type\":\"ack\",\n \"errorCode\":<Id numérico con el status de la solicitud \n (0: solicitud procesada, \n Otro número: Solicitud fallida)\n (ver sección 6. Códigos de error)>,\n \"errorDescription\":\"<Mensaje con la descripción del código de error>\"\n}\nDinama/Mobisa solicitud (se invoca el URL configurado por el cliente para enviar el JSON):
\n\n{\n \"type\":\"receipt\", \n \"serviceSID\":\"<Información entregada por Dinama/Mobisa>\",\n \"recipient\":\"<Número de teléfono que va a recibir la notificación\n en formato internacional>\",\n \"messageId\":\"<Código alfanumérico de identificación del mensaje asociado\n con esta información de estado>\", \n \"statusCode\":<Código de status del envío \n (10: Mensaje recibido por el usuario, \n 100: Mensaje no despachado)>, \n \"statusDescription\":\"<Descripción del status de envío>\"\n}\nCliente respuesta:
\n\n{\n \"type\":\"ack\",\n \"errorCode\":<Id numérico con el status de la solicitud \n (0: solicitud procesada, \n Otro número: Solicitud fallida)\n (ver sección 6. Códigos de error)>,\n \"errorDescription\":\"<Mensaje con la descripción del código de error>\"\n}\n\n0: No hay error\n1: serviceSID inválido\n2: No autorizado \n3: Timeout en la transacción\n4: La información está incompleta\n100: Formato JSON inválido\n101: Error general \n\n\nDefiniciones:
\n\n
\n- Notificación: Contenido a enviar a cada móvil celular a través de mensajes de texto.
\n- Mensaje: Cada uno de los segmentos necesarios para el envío de la notificación. En condiciones normales, una notificación equivale a un mensaje de texto.
\nEn caso que la notificación supere los 160 caracteres, Dinama segmentará dicha notificación de manera automática. Para esto debe incluir parámetros especiales dentro del mensaje de manera que el mismo sea ensamblado nuevamente como un único mensaje en el móvil del suscriptor.\nAl incluir estos parámetros especiales, cada segmento del mensaje contendrá hasta 153 caracteres.\nDe la misma manera, si la notificación posee uno o más caracteres especiales (tales como letras acentuadas o la letra ñ o emoticones), la codificación del mensaje cambia y cada mensaje y/o segmento sólo contendrá hasta 67 caracteres.
\nPor todo lo anterior, al aceptar estos términos y condiciones, usted aprueba que:
\n\n
\n- Dinama envíe tantos mensajes o segmentos sean necesarios para entregar el mensaje unificado al suscriptor.
\n- La operadora celular y Dinama cobran por cada mensaje enviado. De esta manera, si por su longitud o por el uso de caracteres especiales la notificación definida para el usuario debe segmentarse en múltiples mensajes, la operadora celular y Dinama cobrarán por cada uno de los mensajes despachados.
\n
funcionalidad opt-out se encuentra activada):End-point: .../messages/getOptOut?countryCod=<country>
\nEste API permite consultar en un rango de fechas los usuarios que han solicitado no recibir notificaciones
\nRestricciones de este API:
\n\n\n\n
\n- Rango máximo de búsqueda: 15 días
\n- Máximo números de usuarios que puede entregar un invocación: 15000
\n
Cliente solicitud:
\n{\n \"type\": \"getOptOut\",\n \"serviceSID\": \"<Información entregada por Dinama/Mobisa>\",\n \"startDate\": \"<Fecha/Hora (formato yyyymmddHHMMss) \n de inicio de búsqueda>\",\n \"endDate\": \"<Fecha/Hora (formato yyyymmddHHMMss) \n de fin de búsqueda (endDate - startDate <= 15 días)>\"\n}\nDinama/Mobisa respuesta:
\n{\n \"type\": \"getOptOutResp\",\n \"serviceSID\": \"<Información entregada por Dinama/Mobisa>\",\n \"optOuts\": [\n {\n \"user\": \"<Número de teléfono en formato internacional>\",\n \"optOutDate\": \"<Fecha/Hora (formato yyyymmddHHMMss) \n del opt-out>\",\n \"message\": \"<Mensaje enviado que genera el opt-out>\"\n },\n ...\n {\n \"user\": \"<Número de teléfono en formato internacional>\",\n \"optOutDate\": \"<Fecha/Hora (formato yyyymmddHHMMss) \n del opt-out>\",\n \"message\": \"<Mensaje enviado que genera el opt-out>\"\n }\n ],\n \"total\": <Cantidad de usuarios conseguidos>,\n \"errorCode\":<Id numérico con el status de la solicitud \n (0: solicitud procesada, \n Otro número: Solicitud fallida)\n (ver sección 6. Códigos de error)>,\n \"errorDescription\":\"<Mensaje con la descripción del código de error>\"\n} \nDos letras con el código ISO del país donde se va a utilizar el servicio: \nOpciones: \nEC: Ecuador\nPR: Puerto Rico\nVE: Venezuela
\n","type":"text/plain"},"key":"countryCod","value":"Siempre es json
\n","type":"text/plain"},"key":"messageFormat","value":"json"}],"variable":[]}},"response":[{"id":"5690f62d-67fc-411b-938d-f818417ac6f0","name":"JSon Integration - Send Notification","originalRequest":{"method":"POST","header":[{"key":"content-type","value":"application/json"},{"key":"x-api-key","value":"TaluCLg2Ri9JovkeVtKZS9feS82SaneG66y64eOF","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"notify\",\n \"serviceSID\": \"VE-Practipush\",\n \"recipient\": \"584100000000\",\n \"message\": \"Prueba de Envio\",\n \"messageId\": \"ID1234\",\n \"requestDeliveryStatus\": false\n}"},"url":{"raw":"https://api.dinama.com/services/messages?countryCod=ve","protocol":"https","host":["api","dinama","com"],"path":["services","messages"],"query":[{"key":"countryCod","value":"ve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 30 Jul 2019 14:31:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ab2561b3-b2d6-11e9-aba6-79e0eaafa601"},{"key":"x-amz-apigw-id","value":"dpIqzHkYIAMFxMA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5d4054ab-f5b32bd535410aceceed1d09"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"ack\",\n \"errorCode\": 0,\n \"errorDescription\": \"OK\"\n}"}],"_postman_id":"6595c34d-ff5b-47e5-853e-b98db0cadb46"},{"name":"Integración XML1 (Legacy/Obsoleta)","id":"501fd254-7f50-4ae5-9a47-deaf549398b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"text/xml","description":"Content Type del tipo de formato. Siempre text/xml
\n","type":"text"},{"key":"x-api-key","value":"TaluCLg2Ri9JovkeVtKZS9feS82SaneG66y64eOF","description":"API Key asignado por Dinama/Mobisa para autorizar el uso del servicio
\n","type":"text"}],"body":{"mode":"raw","raw":"\nCliente solicitud:
\n <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n <push-request>\n <service-id>Información entregada por Dinama/Mobisa</service-id>\n <user>Número de teléfono del suscriptor en formato internacional (sin el signo de +)</user>\n <text>Mensaje a enviar al suscriptor</text>\n <category>(opcional) Categoria asociada al mensaje (para efectos de reportes)</category>\n <transaction-id>(opcional) ID de Transacción</transaction-id>\n <delivery-receipt>(opcional) 1 para solicitar status del envío, 0 no solicitar status del envío (default 0)</delivery-receipt>\n <allow-concat>1: Para autorizar el uso de mensajes segmentados(concatendos) y codificación UCS2(UTF16) para envío de mensajes \n de longitud mayor a 160 y/o con caracteres acentuados y/o emoticones \n 0: Para rececortar el texto de mensajes de mas de 160 caracteres y no hacer codificación UCS2(UTF16)\n (los caracteres acentuados y/o emoticones no se van a visualizar en el móvil) \n (default: 0)\n * Ver Términos y condiciones si coloca 1 \n </allow-concat>\n <message-id>(opcional) Id único usado usado para identificar el mensaje cuando se solicita el status de envío</message-id>\n <send-date>(opcional) Fecha/Hora (formato yyyymmddHHMMss) para indicar cuándo se debe enviar el mensaje. \n La fecha no puede ser superior a 3 días en el futuro (default: envío inmediato)\n </send-date>\n </push-request>\nDinama/Mobisa respuesta:
\n <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n <push-response>\n <status>Id numérico con el status de la solicitud (0: solicitud procesada, Otro número: Solicitud fallida)(ver 5. Códigos de error) </status>\n <infor>Mensaje con la descripción del status</infor>\n </push-response>\nDinama/Mobisa solicitud (se invoca el URL configurado por el cliente para enviar el XML1):
\n <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n <submit-request>\n <service-id>Información entregada por Dinama/Mobisa</service-id>\n <user>Número de teléfono en formato internacional (sin el signo de +)</user>\n <text>Mensaje enviado por el suscriptor</text>\n <message-id>(opcional) Id único usado usado para identificar el mensaje cuando se solicita el status de envío</message-id>\n </submit-request>\nCliente respuesta:
\n <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n <submit-response>\n <status>Id numérico con el status de la solicitud (0: solicitud procesada, Otro número: Solicitud fallida)(ver 5. Códigos de error) </status>\n <infor>Mensaje con la descripción del status</infor>\n </submit-response>\nCliente solicitud:
\n <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n <deliver-request>\n <service-id>Información entregada por Dinama/Mobisa</service-id>\n <user>Número de teléfono del suscriptor en formato internacional (sin el signo de +)</user>\n <text>Mensaje a enviar al suscriptor</text>\n <transaction-id>(opcional) ID de Transacción</transaction-id>\n <delivery-receipt>(opcional) 1 para solicitar status del envío, 0 no solicitar status del envío (default 0)</delivery-receipt>\n <allow-concat>1: Para autorizar el uso de mensajes segmentados(concatenados) y codificación UCS2(UTF16) para envío de mensajes \n de longitud mayor a 160 y/o con caracteres acentuados y/o emoticones \n 0: Para recortar el texto en mensajes de mas de 160 caracteres y no hacer codificación UCS2(UTF16)\n (los caracteres acentuados y/o emoticones no se van a visualizar en el móvil) (default: 0)\n * Ver Términos y condiciones si coloca 1 \n </allow-concat>\n <message-id>(opcional) Id único usado usado para identificar el mensaje cuando se solicita el status de envío</message-id>\n </deliver-request>\nDinama/Mobisa Respuesta:
\n <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n <deliver-response>\n <status>Id numérico con el status de la solicitud (0: solicitud procesada, Otro número: Solicitud fallida)(ver 5. Códigos de error) </status>\n <infor>Mensaje con la descripción del status</infor>\n </deliver-response>\nDinama/Mobisa solicitud (se invoca el URL configurado por el cliente para enviar el XML1):
\n <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n <receipt-request>\n <message-id>Id del mensaje asociado a este acuse de recibo</message-id>\n <status-code>Código de status del envío (10: Mensaje recibido por el usuario, 100: Mensaje no despachado)</status-coder>\n <status-description>Descripción del status de envío</status-description>\n </receipt-request>\nCliente respuesta:
\n <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n <receipt-response>\n <status>Id numérico con el status de la solicitud (0: solicitud procesada, Otro número: Solicitud fallida)(ver 5. Códigos de error) </status>\n <infor>Mensaje con la descripción del status</infor>\n </receipt-response>\n 0: No hay error\n 1: serviceSID inválido\n 2: No autorizado \n 3: Timeout en la transacción\n 4: La información está incompleta\n 100: Formato XML inválido\n 101: Error general \n\n\n","urlObject":{"protocol":"https","path":["services","messages"],"host":["api","dinama","com"],"query":[{"description":{"content":"Definiciones:
\n\n
\n- Notificación: Contenido a enviar a cada móvil celular a través de mensajes de texto.
\n- Mensaje: Cada uno de los segmentos necesarios para el envío de la notificación. En condiciones normales, una notificación equivale a un mensaje de texto.
\nEn caso que la notificación supere los 160 caracteres, Dinama segmentará dicha notificación de manera automática. Para esto debe incluir parámetros especiales dentro del mensaje de manera que el mismo sea ensamblado nuevamente como un único mensaje en el móvil del suscriptor.\nAl incluir estos parámetros especiales, cada segmento del mensaje contendrá hasta 153 caracteres.\nDe la misma manera, si la notificación posee uno o más caracteres especiales (tales como letras acentuadas o la letra ñ o emoticones), la codificación del mensaje cambia y cada mensaje y/o segmento sólo contendrá hasta 67 caracteres.
\nPor todo lo anterior, al aceptar estos términos y condiciones, usted aprueba que:
\n\n
\n- Dinama envíe tantos mensajes o segmentos sean necesarios para entregar el mensaje unificado al suscriptor.
\n- La operadora celular y Dinama cobran por cada mensaje enviado. De esta manera, si por su longitud o por el uso de caracteres especiales la notificación definida para el usuario debe segmentarse en múltiples mensajes, la operadora celular y Dinama cobrarán por cada uno de los mensajes despachados.
\n
Dos letras con el código ISO del país donde se va a utilizar el servicio: \nOpciones: \nEC: Ecuador\nPR: Puerto Rico\nVE: Venezuela
\n","type":"text/plain"},"key":"countryCod","value":"ve"},{"description":{"content":"Siempre es xml1
\n","type":"text/plain"},"key":"messageFormat","value":"xml1"}],"variable":[]}},"response":[{"id":"9ace42eb-6c4a-47eb-afb2-3a10796e2330","name":"XML1 Integration","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"},{"key":"x-api-key","value":"TaluCLg2Ri9JovkeVtKZS9feS82SaneG66y64eOF","type":"text"}],"body":{"mode":"raw","raw":"\n