MRAM SMS API Documentation
MRAM SMS API Documentation
When sending multiple SMS messages to various contacts using the MRAM SMS API, critical parameters include 'api_key', 'senderid', and 'messages'. The 'messages' parameter should contain an array of objects, each detailing individual mobile numbers and corresponding SMS text. These parameters ensure that multiple messages are correctly routed to the intended recipients .
MRAM SMS API error codes facilitate debugging by providing precise and descriptive feedback on why an API request failed. Each error code corresponds to specific issues, such as 'Sender Id/Masking Not Found' (1002), 'Invalid User & Password' (1010), or 'Balance Insufficient' (1007). By using these codes, developers can quickly identify and rectify problems within the messaging workflow, thereby enhancing efficiency and reducing downtime .
The 'api_key' in the MRAM SMS API is a critical component used for authenticating and authorizing API requests. Users must generate this key by logging into the SMS panel, navigating to the Developers section, and clicking on 'Regenerate Key'. The API Key is a unique identifier that must be approved by MRAM SMS authority to ensure that messages are not denied by the system .
Developers can confirm the SMS API's credit balance by accessing the Credit Balance API. They need to send a request to the API endpoint with their API key to retrieve the current SMS credit available in their account. This ensures that they have sufficient credits before attempting to send messages, thus avoiding errors like 'Balance Insufficient' .
The MRAM SMS API identifies errors related to invalid user credentials using specific error codes. The error code 1010 indicates 'Invalid User & Password', and the error code 1011 signifies 'Invalid User Id'. These error codes notify the user that there is an authentication failure due to incorrect credentials provided in the API request .
To retrieve unread replies from recipients using the MRAM SMS API, developers should utilize the Inbox Reply API. The process involves making a GET request to the API endpoint 'https://msg.mram.com.bd/miscapi/{API_KEY}/getUnreadReplies' with their corresponding API_KEY. This request pulls data about unread SMS replies from recipients .
The 'SMSC Timeout-abort' status code, indicated by the codes 400 or 456, is encountered when there is a timeout issue with the Short Message Service Center (SMSC). This status suggests a failure in communication between the MRAM SMS API and the SMSC, possibly due to network issues, excessive load, or any interruption that prevents timely processing of SMS requests .
The sender ID in the MRAM SMS API is crucial as it identifies the sender to the recipient. It affects message delivery because the sender ID must be pre-approved and provided in the API parameters. An unrecognized or incorrect sender ID could lead to errors such as 'Sender Id/Masking Not Found', thereby preventing the message from being sent .
DLR (Delivery Report) Status Codes are vital for assessing the reliability of communication through the MRAM SMS API. They provide real-time feedback on message delivery status, such as 'Delivered' (0, 1), 'Undelivered' (32), and various failures due to network issues or subscriber availability. This information allows developers to diagnose delivery issues and ensures robust, dependable SMS messaging services .
The MRAM SMS API allows users to schedule SMS messages by using the 'scheduledDateTime' parameter. This optional parameter specifies the date and time for SMS delivery, allowing users to send messages at their preferred time. The API request must include this parameter to enable scheduling .