Send SMS

Resend Unsent SMS

LOG SMS Sent

Get SMS received

Delete SMS

SMS Received - Webhook

Authentication

Send SMS

Endpoint: 

Parameters:

Example:

Resend an unsent SMS

 This API endpoint is used to resend an unsent SMS (only if the message has an error status)

Endpoint:

Parameter: 

Example:

Log of SMS sent from the API  

This API endpoint is used to retrieve the log of SMS messages sent via the API.

Endpoint:  

Parameter:

Example:

SMS Received

This API endpoint is used to retrieve SMS messages received on the smartphone. 

Endpoint:

Parameter: 

Example:

Delete SMS

This API endpoint is used to delete SMS messages from the server log of SMS Mobile API

Endpoint:  

Parameter:

Example:

Note: The deleted SMS are only those stored in the logs of your mobile app account. SMS on the mobile device itself will not be deleted, as we do not have access to them.

Webhook – SMS Received

This webhook system sends a POST request to the configured URL whenever an SMS is received. The system ensures real-time updates by delivering the SMS details to the specified webhook URL.

How to Configure the Webhook in the Dashboard

Follow these steps to set up your webhook URL in the dashboard:

1. Log in to your account on the SMS Mobile API Dashboard.
2. Navigate to the Webhook Settings section.
3. Enter your webhook URL (e.g., https://example.com/webhook-endpoint
4. Click on the Save Webhook button. 
5. Once saved, the system will start sending SMS details to the configured URL.

Webhook Payload

When an SMS is received, the system sends the following JSON payload to your webhook URL:

{

    "date": "2025-01-20",

    "hour": "10:15:00",

    "time_received": "2025-01-20 10:14:50",

    "message": "Hello, this is a test.",

    "number": "+123456789",

    "guid": "abcde12345"

}

Payload Fields:

• date: Date when the SMS was added (YYYY-MM-DD).
• hour: Hour when the SMS was added (HH:mm:ss).
• time_received: Time when the SMS was received.
• message: Content of the SMS. 
• number: Sender's phone number.
• guid: Unique identifier of the SMS.

Example Webhook Endpoint

Your server should be ready to handle incoming POST requests. Below is an example PHP script to process the webhook payload:

<?php

// Read the incoming payload

$payload = file_get_contents('php://input');

$data = json_decode($payload, true);




// Process the SMS data

if ($data) {

    // Example: Log the SMS data to a file

    file_put_contents('sms_log.txt', print_r($data, true), FILE_APPEND);




    // Respond with HTTP 200 status

    http_response_code(200);

    echo "Webhook received successfully.";

} else {

    // Respond with HTTP 400 status for bad requests

    http_response_code(400);


    echo "Invalid payload.";

}

?>

Testing the Webhook

To test your webhook configuration, use tools like:

• Webhook.site
• RequestBin

These tools allow you to inspect the payload sent by the system and debug any issues with your webhook setup.

Troubleshooting

• Ensure the webhook URL is correct and publicly accessible.
• Verify that your server is returning an HTTP 200 status code for successful requests.
• Check your server logs for any errors in processing the payload.

Authentication

The SMSMobile API supports two authentication methods: using a simple API Key or the OAuth2 protocol with a client ID and client secret.

1. API Key Authentication

 This method requires an API Key that can be included as a parameter in either a GET or POST request. It is a straightforward way to authenticate your API requests.

2. OAuth2 Authentication

OAuth2 provides a more secure and scalable authentication method.
You will need to use a client ID and client secret to obtain an access token, which should then be included in your API requests using the Authorization header.

Obtaining an Access Token

To get an access token, send a POST request to the token endpoint with your client ID and client secret.

Using the Access Token:

Once you have the access token, include it in the Authorization header of your API requests:

Which Method Should You Use?

- Use API Key Authentication for quick and straightforward integrations.

- Use OAuth2 Authentication for enhanced security and scalability in your integrations.

For more details, please refer to the full documentation.