Documentation for Dinama/Mobisa SMS
\n\n\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"3895335","collectionId":"7795653d-6b26-44f7-a3a1-e55fef87b374","publishedId":"S1EQSxoS","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-02-21T20:27:23.000Z"},"item":[{"name":"JSon Integration (Recommended)","id":"9471fbb1-71de-4ea0-a606-b19baa7db587","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"content-type","value":"application/json","description":"
Content Type of the message format. Always application/json
\n"},{"key":"x-api-key","value":"TaluCLg2Ri9JovkeVtKZS9feS82SaneG66y64eOF","description":"API Key asigned by Dinama/Mobisa in order to access the service
\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=Client request:
\n{\n \"type\":\"notify\",\n \"serviceSID\":\"<Value provided by Dinama/Mobisa>\",\n \"recipient\":\"<hone number that will receive the notification in international format>\",\n \"message\":\"<Text to send>\",\n \"messageId\":\"<(optional) Unique message Id, used when delivery status is requested>\", \n \"transactionId\":\"<(optional) Transaction ID>\",\n \"memo\":\"<(optional) Category for reports purposes>\",\n \"sendDate\":\"<(optional) Date/Time (format yyyymmddHHMMss) when the message must be sent \n (default: now)>\",\n \"requestDeliveryStatus\":\"<(optional) true:To request delivery status,\n false:delivery status not requested\n (default false)>\",\n \"allowConcat\": < true: To authorize send concatenated messages with or without UCS2(UTF16) encoding \n required for long text messages and correct delivery of accent letters and emoticons\n * View Terms and Conditions that apply when the value is true (section 7)\n false: Cut message to 160 characters, accent letters and emoticons won't be displayed\n in the phone \n (default: false)\n >\n}\n\nDinama/Mobisa response:
\n{\n \"type\":\"ack\",\n \"errorCode\":<Processing/invocation status response\n (0: request processed, \n Other: Request failed)>,\n \"errorDescription\":\"<Error description message>\"\n}\nSend multiple notification messages with one api call
\n\nRestrictions:
\n
\nMaximum JSON payload size: 6 MB
\nMaximum number of notifications that can be sent per invocation: 10,000
Client request:
\n{\n \"type\":\"notifyBatch\",\n \"serviceSID\":\"<Value provided by Dinama/Mobisa>\",\n \"messages\": [\n {\"recipient\":\"<Phone number that will receive the notification in international format>\",\n \"message\":\"<Message to send>\",\n \"messageId\":\"<(optional) Unique message Id, used when delivery status is requested>\", \n }, \n\n ...\n {\"recipient\":\"<Phone number that will receive the notification in international format>\",\n \"message\":\"<Message to send>\",\n \"messageId\":\"<(optional) Unique message Id, used when delivery status is requested>\", \n }\n ], \n \"transactionId\":\"<(optional) Transaction ID>\",\n \"memo\":\"<(optional) Category for reports purposes>\",\n \"sendDate\":\"<(optional) Date/Time (format yyyymmddHHMMss) when the message must be sent \n (default: now)>\",\n \"requestDeliveryStatus\":\"<(optional) true:To request delivery status,\n false:delivery status not requested\n (default false)>\",\n \"allowConcat\": < true: To authorize send concatenated messages with or without UCS2(UTF16) encoding \n required for long text messages and correct delivery of accent letters and emoticons\n * View Terms and Conditions that apply when the value is true (section 7)\n false: Cut message to 160 characters, accent letters and emoticons won't be displayed\n in the phone \n (default: false)\n >\n}\nDinama/Mobisa response:
\n{\n \"type\":\"ack\",\n \"errorCode\":<Processing/invocation status response\n (0: request processed, \n Other: Request failed)>,\n \"errorDescription\":\"<Error description message>\"\n}\nDinama/Mobisa calls the URL defined by the Client:
\n{\n \"type\":\"request\", \n \"serviceSID\":\"<Value provided by Dinama/Mobisa>\",\n \"sender\":\"<Sender Phone number in international format>\",\n \"message\":\"<Message sent by the mobile>\",\n \"transactionId\":\"<(optional) Transaction ID>\",\n}\nClient response:
\n{\n \"type\":\"ack\",\n \"errorCode\": <Processing/invocation status response \n (0: request processed successfully, \n Other number: request failed)\n (see section 6. Error codes)>,\n \"errorDescription\":\"<Error description message>\"\n}\nClient request:
\n{\n \"type\":\"response\", \n \"serviceSID\":\"<Value provided by Dinama/Mobisa>\",\n \"recipient\":\"<Phone number that will receive the notification in international format>\",\n \"message\":\"<Message to send>\",\n \"messageId\":\"<(optional) Unique message Id, used when delivery status is requested>\",\n \"transactionId\":\"<(optional) Transaction ID>\", \n \"memo\":\"<(optional) Category for reports purposes>\",\n \"requestDeliveryStatus\":\"<(optional) true:To request delivery status,\n false:delivery status not requested\n (default false)>\",\n \"allowConcat\": < true: To authorize send concatenated messages with or without UCS2(UTF16) encoding \n required for long text messages and correct delivery of accent letters and emoticons\n * View Terms and Conditions that apply when the value is true (section 7)\n false: Cut message to 160 characters, accent letters and emoticons won't be displayed\n in the phone \n (default: false)\n >\n}\nDinama/Mobisa response:
\n{\n \"type\":\"ack\",\n \"errorCode\": <Processing/invocation status response \n (0: request processed successfully, \n Other number: request failed)\n (see section 6. Error codes)>,\n \"errorDescription\":\"<Error description message>\"\n}\nDinama/Mobisa calls the URL defined by the Client:
\n{\n \"type\":\"receipt\", \n \"serviceSID\":\"<Value provided by Dinama/Mobisa>\",\n \"recipient\":\"<Phone number that will receive the notification in international format>\",\n \"messageId\":\"<Unique message Id, associated with this delivery status>\", \n \"statusCode\":<Delivery Status Cod \n (10: Message received by the user, \n 100: Message not sent)>, \n \"statusDescription\":\"<Delivery status Descripion>\"\n}\nClient response:
\n{\n \"type\":\"ack\",\n \"errorCode\": <Processing/invocation status response \n (0: request processed successfully, \n Other number: request failed)\n (see section 6. Error codes)>,\n \"errorDescription\":\"<Error description message>\"\n}\n0: No Error, message queued for delivery\n1: Invalid serviceSID\n2: Not authorized \n3: Transaction Time out \n4: Missing information\n100: Invalid JSON format\n101: General error\n\n\nDefinitions:
\n\n
\n- Notification: Content to be sent to each cell phone through text messages.
\n- Message: Each of the segments necessary to send the notification. Under normal conditions, a notification is equivalent to a text message
\nIn the event that the notification exceeds 160 characters, Dinama will segment the messages automatically. For this, it must include special parameters within the message so that it is reassembled as a single message in the subscriber's mobile.\nBy including these special parameters, each segment of the message can contain up to 153 characters.\nIn the same way, if the message contains one or more special characters (such as accented letters or the letter ñ or emoticons), the encoding of the message changes and each message and/or segment can contain up to 67 characters.\nFor all of the above, by accepting these terms and conditions, you agree that:\"
\n\n
\n- Dinama sends as many messages or segments as necessary to deliver the unified message to the subscriber.
\n- The carrier and Dinama charge for each message sent. In this way, if the notification length is longer than 160 characters and/or it has special characters, the defined message must be segmented into multiple parts, the carrier and Dinama will charge for each of the dispatched parts (segments)
\n
opt-out functionality is enabled):End-point: .../messages/getOptOut?countryCod=<country>
\nThis API allows querying users who have requested not to receive notifications within a specified date range.
\nRestrictions for this API:
\n\n\n\n
\n- Maximum search range: 15 days
\n- Maximum number of users that can be returned in a single invocation: 15,000
\n
Client request:
\n{\n \"type\": \"getOptOut\",\n \"serviceSID\": \"<Information provided by Dinama/Mobisa>\",\n \"startDate\": \"<Start date/time (format yyyymmddHHMMss) \n for the search range>\",\n \"endDate\": \"<End date/time (format yyyymmddHHMMss) \n for the search range (endDate - startDate <= 15 days)>\"\n}\nDinama/Mobisa response:
\n{\n \"type\": \"getOptOutResp\",\n \"serviceSID\": \"<Information provided by Dinama/Mobisa>\",\n \"optOuts\": [\n {\n \"user\": \"<Phone number in international format>\",\n \"optOutDate\": \"<Date/time (format yyyymmddHHMMss) \n of the opt-out>\",\n \"message\": \"<Sent message that triggered the opt-out>\"\n },\n ...\n {\n \"user\": \"<Phone number in international format>\",\n \"optOutDate\": \"<Date/time (format yyyymmddHHMMss) \n of the opt-out>\",\n \"message\": \"<Sent message that triggered the opt-out>\"\n }\n ],\n \"total\": <Number of users found>,\n \"errorCode\": <Processing/invocation status response \n (0: request processed successfully, \n Other number: request failed)\n (see section 6. Error codes)>,\n \"errorDescription\": \"<Message with the description of the error code>\"\n}\nTwo letter ISO name of the country where the messages are going to be delivered: Options: EC: Ecuador, PR: Puerto Rico, VE: Venezuela
\n","type":"text/plain"},"key":"countryCod","value":"Always json
\n","type":"text/plain"},"key":"messageFormat","value":"json"}],"variable":[]}},"response":[{"id":"2d848b32-0937-40b1-a6c1-668ddd6feb2f","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":"9471fbb1-71de-4ea0-a606-b19baa7db587"},{"name":"XML1 Integration (Legacy/Obsolete)","id":"b538ee39-5c66-44e6-b5c7-a724ebd70422","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"text/xml","description":"Content Type of the message format. Always text/xml
\n","type":"text"},{"key":"x-api-key","value":"TaluCLg2Ri9JovkeVtKZS9feS82SaneG66y64eOF","description":"API Key asigned by Dinama/Mobisa in order to access the service
\n","type":"text"}],"body":{"mode":"raw","raw":"\nClient request:
\n <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n <push-request>\n <service-id>Value provided by Dinama/Mobisa</service-id>\n <user>Phone number international format (without + sign)</user>\n <text>Text to send</text>\n <category>(optional) Category for reports purposes</category>\n <transaction-id>(optional) Transaction ID</transaction-id>\n <delivery-receipt>(optional) 1 To request delivery status, 0 delivery status not requested (default 0)</delivery-receipt>\n <allow-concat>1: To authorize send concatenated messages with or without UCS2(UTF16) encoding when needed \n 0: Cut message to 160 characters and don't use UCS2(UTF16) encoding (default: 0)\n * View Terms and Conditions\n </allow-concat>\n <message-id>(optional) Unique message Id, used when delivery status is requested</message-id>\n <send-date>(optional) Date/Time (format yyyymmddHHMMss) when the message must be sent (default: now)</send-date>\n </push-request>\nDinama/Mobisa response:
\n <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n <push-response>\n <status>Processing status (0: request processed, Other: Request failed )</status>\n <infor>Status description message</infor>\n </push-response>\nDinama/Mobisa request (call to the URL defined by the Client):
\n <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n <submit-request>\n <service-id>Value provided by Dinama/Mobisa</service-id>\n <user>Phone number international format (without + sign)</user>\n <text>Text sent by the user</text>\n <message-id>(optional) Unique message Id, used when delivery status is requested</message-id>\n </submit-request>\nClient Response:
\n <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n <submit-response>\n <status>Processing status (0: request processed, Other: Request failed )</status>\n <infor>Status description message</infor>\n </submit-response>\nClient request:
\n <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n <deliver-request>\n <service-id>Value provided by Dinama/Mobisa</service-id>\n <user>Phone number international format (without + sign)</user>\n <text>Text to send</text>\n <transaction-id>(optional) Transaction ID</transaction-id>\n <delivery-receipt>(optional) 1 To request delivery status, 0 delivery status not requested (default 0)</delivery-receipt>\n <allow-concat>1: To authorize send concatenated messages with or without UCS2(UTF16) encoding when needed \n 0: Cut message to 160 characters and don't use UCS2(UTF16) encoding (default: 0)\n * View Terms and Conditions\n </allow-concat>\n <message-id>(optional) Unique message Id, used when delivery status is requested</message-id>\n </deliver-request>\nDinama/Mobisa Response:
\n <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n <deliver-response>\n <status>Processing status (0: request processed, Other: Request failed )</status>\n <infor>Status description message</infor>\n </deliver-response>\nDinama/Mobisa request (call to the URL defined by the Client):
\n <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n <receipt-request>\n <message-id>Unique message Id, associated to this request</message-id>\n <status-code>Delivery Status Cod (10: Message received by the user, 100: Message not sent)</status-coder>\n <status-description>Delivery status Descripion</status-description>\n </receipt-request>\nClient response:
\n <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n <receipt-response>\n <status>Processing status (0: request processed, Other: Request failed )</status>\n <infor>Status description message</infor>\n </receipt-response>\n 0: No Error, message queued for delivery\n 1: Invalid serviceSID\n 2: Not authorized \n 3: Transaction Time out \n 4: Missing information\n 100: Invalid XML format\n 101: General error \n\n\n","urlObject":{"protocol":"https","path":["services","messages"],"host":["api","dinama","com"],"query":[{"description":{"content":"Definitions:
\n\n
\n- Notification: Content to be sent to each cell phone through text messages.
\n- Message: Each of the segments necessary to send the notification. Under normal conditions, a notification is equivalent to a text message
\nIn the event that the notification exceeds 160 characters, Dinama will segment the messages automatically. For this, it must include special parameters within the message so that it is reassembled as a single message in the subscriber's mobile.\nBy including these special parameters, each segment of the message can contain up to 153 characters.\nIn the same way, if the message contains one or more special characters (such as accented letters or the letter ñ or emoticons), the encoding of the message changes and each message and/or segment can contain up to 67 characters.\nFor all of the above, by accepting these terms and conditions, you agree that:\"
\n\n
\n- Dinama sends as many messages or segments as necessary to deliver the unified message to the subscriber.
\n- The carrier and Dinama charge for each message sent. In this way, if the notification length is longer than 160 characters and/or it has special characters, the defined message must be segmented into multiple parts, the carrier and Dinama will charge for each of the dispatched parts (segments)
\n
Two letter ISO name of the country where the messages are going to be delivered: Options: EC: Ecuador, PR: Puerto Rico, VE: Venezuela
\n","type":"text/plain"},"key":"countryCod","value":"ve"},{"description":{"content":"Always xml1
\n","type":"text/plain"},"key":"messageFormat","value":"xml1"}],"variable":[]}},"response":[{"id":"0013ef1d-1911-45aa-b9d5-63d938546168","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