{"id":694,"date":"2024-11-09T13:50:05","date_gmt":"2024-11-09T08:20:05","guid":{"rendered":"https:\/\/www.msgclub.net\/learn\/?p=694"},"modified":"2024-11-09T13:50:05","modified_gmt":"2024-11-09T08:20:05","slug":"developer-api-description","status":"publish","type":"post","link":"https:\/\/www.msgclub.net\/learn\/developer-api-description.html","title":{"rendered":"Developer API Description"},"content":{"rendered":"\n

The Developer API page is designed for users who want to send SMS messages directly from their own software applications. By integrating the MsgClub API, users can efficiently manage their SMS communications after proper configuration.<\/p>\n\n\n\n

Where to find the option of developer API <\/strong><\/h3>\n\n\n\n

>> After login your SMS panel<\/p>\n\n\n\n

>> At the left side menu find a option \u201cDeveloper API\u201c<\/p>\n\n\n\n

>> Once you click on the option so a new page will open where you will find all the API for all service<\/p>\n\n\n\n

Key Features of the Developer API Page<\/strong><\/h3>\n\n\n\n

1. Service Selection<\/strong><\/h4>\n\n\n\n

At the top of the Developer API page, users can select the specific service they wish to utilize for their API needs. This allows for integration based on the service requirements.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

2. Error Code Reference<\/strong><\/h4>\n\n\n\n

Users can access a list of error codes associated with the API. For instance, error code 3001<\/strong> indicates a successful submission of an API request to the system. This section helps developers troubleshoot any issues that may face during integration.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

3. Push DLR Settings<\/strong><\/h4>\n\n\n\n

This section allows users to configure Delivery Receipt (DLR) settings for their server. Many users sending SMS through their panels require the ability to push DLR status updates, making this feature essential for tracking message delivery.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

4. Authentication Key<\/strong><\/h4>\n\n\n\n

To use the API, users must authenticate their requests. The Authentication Key serves as a permission grant, allowing users to access the API under their account. Users can generate this key using a dedicated button on the page.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

API Details<\/strong><\/h3>\n\n\n\n

After selecting the desired API, the following details are provided:<\/p>\n\n\n\n

    \n
  • API Endpoint:<\/strong> This section displays the specific API URL for sending SMS.<\/li>\n\n\n\n
  • Sample Code:<\/strong> Here, users will find code snippets related to the selected API, making it easier to implement in their applications.<\/li>\n<\/ul>\n\n\n\n
    \"\"<\/figure>\n\n\n\n
      \n
    • Single API:<\/strong> This is a GET API used for sending a single SMS message.<\/li>\n<\/ul>\n\n\n\n
      \"\"<\/figure>\n\n\n\n
        \n
      • API Parameter<\/strong> – API parameter help user to set the specific detail of the user which need to be send like- Mobile number, Entity ID, message ETC<\/li>\n<\/ul>\n\n\n\n
        \"\"<\/figure>\n\n\n\n
          \n
        • POST API:<\/strong> Users can employ this API to send SMS messages in bulk, allowing for efficient communication.<\/li>\n<\/ul>\n\n\n\n
          \"\"<\/figure>\n\n\n\n
            \n
          • Sample Output:<\/strong> If a user successfully hits the API, this section provides the expected output code, confirming the success of the operation.<\/li>\n<\/ul>\n\n\n\n
            \n