Dev DOC WhatsApp - SMSMobileAPI

WhatsApp Documentation

This documentation is specific to sending and receiving WhatsApp messages.

Click here to learn more about all the features our WhatsApp integration offers.

At SMSmobileAPI, we strive to make our API as compatible as possible with any architecture or platform.
Whether you’re using REST, SOAP, cURL, or various programming languages like Python, JavaScript, PHP, and more, our API is designed to integrate seamlessly into your projects.

We also have ready-to-use plugins for e-commerce solutions and software. Click here to discover them.

API REST

cURL

JavaScript

Python

Node.js

Ruby

WSDL

Authentication

API KEY
OAuth2

Send WhatsApp API

This API endpoint is used to send WhatsApp messages.

Endpoint:

GET POST https://api.smsmobileapi.com/sendsms

Parameters:

- apikey: Your unique API key.

- recipients: The recipient's phone number (The number must be available on WhatsApp). Enter the phone number starting with the country code (without ‘+’ and without ‘00’), followed directly by the rest of your number. Exemple 191728660

- message: The message to send (Multiple lines possible).

- url_media: The direct URL of the media file you want to send via WhatsApp. Must start with https:// and point to a valid PDF, doc or image file. The file must be publicly accessible without authentication.
Supported : pdf, xml, doc, docx, odt, rtf, txt, tex, xls, xlsx, csv, ods, ppt, pptx, odp, zip, rar, 7z, tar, gz
jpg, jpeg, png

- waonly: must have the value yes -> Required to specify that only one WhatsApp message should be sent

- pdf_with_image- >If the value is "yes", then an image preview of the PDF will be displayed to accompany the message (only if it is a PDF).

- url_media_shorted- >If the value is "yes", In the case of a PDF with the condition [pdf_with_image=yes], the display of the download link for the PDF goes through a short URL

Example without media :


        GET https://api.smsmobileapi.com/sendsms?apikey=YOUR_API_KEY&waonly=yes&recipients=191728660&message=Hello%20World

Example with media :


        GET https://api.smsmobileapi.com/sendsms?apikey=YOUR_API_KEY&waonly=yes&recipients=191728660&message=Hello%20World&url_media=https://smsmobileapi.com/logo.png

Format Text in WhatsApp :

Italic: Use underscores → _text_
Bold: Use asterisks → *text*
Strikethrough: Use tildes → ~text~
Monospace: Use backticks → ```text```

For example : _Hello_ world, How *are* you ~today~ from ```SMSMobileAPI```

Resend an unsent WhatsApp messages

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

Endpoint:

GET POST https://api.smsmobileapi.com/resendwa/

Parameter:

- guid: (required) GUID of the message to be resent.

Example:


        GET https://api.smsmobileapi.com/resendwa/?apikey=YOUR_API_KEY&guid=GUID_OF_THE_MESSAGE

Synchronization to retrieve message

This API endpoint is used to send a request to synchronize and retrieve WhatsApp messages.
This step is mandatory and must be executed before calling the endpoint that retrieves the messages.

Warning: Synchronization is strictly required only for the message retrieval function. Do not start a synchronization to send a message.

Endpoint:

GET https://api.smsmobileapi.com/getwa/synchronisation/

Parameter:

- apikey (required): The API key you have or will receive.

Example:


        GET https://api.smsmobileapi.com/getwa/synchronisation/?apikey=YOUR_API_KEY

Reply :



{


 "error": "0",

   "messages": "synchronized",

  "expire_at	": "2025-03-11 12:27:00",

  "expire_at_unix": "1741692420",


 

}

Retrieve WhatsApp Message

This API endpoint is used to retrieve WhatsApp messages received.

Endpoint:

GET https://api.smsmobileapi.com/getwa

Parameter:

- apikey (required): The API key you have or will receive.

- before (optional): Pass the timestamp as a parameter and display the records below this timestamp.

- date (optional): (yyyy-mm-dd) get all records based on the date.

- message_type (optional):

Leave empty to see all (text and audi messages)
use 'text' to see only text messages
use 'audio' to see only audio messages converted to text

Example:


        GET https://api.smsmobileapi.com/getwa/?apikey=YOUR_API_KEY

Reply :



{


  "date": "2025-03-11",

  "hour": "12:27:00",

  "timestamp": "1741692420",

  "number": "19176728660",

  "contact": "Smsmobileapi",

  "message": "Can you tell me when I will receive my order?",

  "guid": "652fcfc0-12a8-46f5-b5ba-9391135b8b4c",

  
  "more": {

    "auto_reply": "1",

    "transfert_to_email": "1",

    "chatgpt_reply": "1"

	
  },


  "chatgpt": {

    "prompt_tokens": "900",

    "completion_tokens": "10",

    "total_tokens": "910",

    "total_tokens_cost": "0.182"

	 "response": "Your order #576 will be shipped tomorrow."

	
  }

    
  
}

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

To send or retrieve WhatsApp messages via our API, authentication is required using an API key. This ensures secure and authorized access to the messaging service. Simply include your API key in the request to authenticate and start sending messages seamlessly.

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.

The client_id and client_secret are available in your dashboard.

Obtaining an Access Token

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


curl -X POST https://api.smsmobileapi.com/oauth2/token \

-H "Content-Type: application/x-www-form-urlencoded" \

-d "grant_type=client_credentials" \

-d "client_id=1ab0ex4b4c1ef2c800690d" \

-d "client_secret=3ed108a93d0414074b94364290b6a7348475e93a0567005"

Using the Access Token:

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


curl -X POST https://api.smsmobileapi.com/sendsms?waonly=yes \

-H "Authorization: Bearer abc123xyz456" \

-H "Content-Type: application/x-www-form-urlencoded" \

-d "recipients=+1234567890" \

-d "message=Hello"

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.

Send WhatsApp message

WSDL URL

https://api.smsmobileapi.com/sendsms/wsdl/sendsms.wsdl

Parameters:

- recipients: The mobile number of the recipient.

- message: The message to send.

- apikey: The API key you have or will receive.

- waonly: must have the value yes -> Required to specify that only one WhatsApp message should be sent.

Exemple


                require_once "lib/nusoap.php";

                

                $client = new nusoap_client("https://api.smsmobileapi.com/sendsms/wsdl/sendsms.wsdl", true);

                $error  = $client->getError();

                

                $result = $client->call("sendSms", array("waonly" =>"yes","recipients" =>$_GET['recipients'],"message" =>$_GET['message'],"apikey" =>$_GET['apikey']));

                

                print_r($result);

Send WhatsApp

Basic cURL Command

You can use the following cURL command to send a WhatsApp message via the SMSmobileAPI:


        curl -X POST https://api.smsmobileapi.com/sendsms/?waonly=yes \

        -d "recipients=PHONE_NUMBER" \

        -d "message=YOUR_MESSAGE" \

        -d "apikey=YOUR_API_KEY"

cURL Example in PHP

If you're using PHP, here's how you can send an WhatsApp message using cURL:


        <?php

        

        $url = 'https://api.smsmobileapi.com/sendsms/?waonly=yes';

        $data = array(

            'recipients' => 'PHONE_NUMBER',

            'message' => 'YOUR_MESSAGE',

            'apikey' => 'YOUR_API_KEY'


        );

        

        $options = array(

            CURLOPT_URL => $url,

            CURLOPT_POST => true,

            CURLOPT_POSTFIELDS => http_build_query($data),

            CURLOPT_RETURNTRANSFER => true,

        );

        

        $ch = curl_init();

        curl_setopt_array($ch, $options);

        $response = curl_exec($ch);

        curl_close($ch);

        

        echo $response;

        

        ?>

This PHP example demonstrates how to send a POST request using cURL to the SMSmobileAPI, passing the necessary parameters as an associative array.

Send WhatsApp

Use our officiel Python Module : https://smsmobileapi.com/python/
or use the manuel way ...

Using the `requests` Library

The `requests` library is a popular and simple HTTP library for Python. Here's how you can use it to send an WhatsApp message via the SMSmobileAPI:


        import requests



        url = "https://api.smsmobileapi.com/sendsms/waonly=yes"



        payload = {

            "recipients": "PHONE_NUMBER",

            "message": "YOUR_MESSAGE",

            "apikey": "YOUR_API_KEY"

        }



        response = requests.post(url, data=payload)



        print(response.text)

This example demonstrates a simple POST request to the SMSmobileAPI, sending a WhatsApp message to a specific phone number.

Using the `http.client` Library

The `http.client` library is included in the standard library of Python and can also be used to interact with your API:


        import http.client

        import urllib.parse



        conn = http.client.HTTPSConnection("api.smsmobileapi.com")



        params = urllib.parse.urlencode({

            "recipients": "PHONE_NUMBER",

            "message": "YOUR_MESSAGE",

            "apikey": "YOUR_API_KEY"

        })



        headers = { "Content-type": "application/x-www-form-urlencoded" }



        conn.request("POST", "/sendsms/?waonly=yes", params, headers)

        response = conn.getresponse()

        data = response.read()



        print(data.decode("utf-8"))

        conn.close()

This example shows how to use the `http.client` library to send a POST request to the API. The parameters are URL-encoded and sent with the appropriate headers.

Send WhatsApp

Using the `fetch` API

The `fetch` API is a modern and versatile way to make HTTP requests in JavaScript. Here's how you can use it to send a WhatsApp message via the SMSmobileAPI:


        const url = "https://api.smsmobileapi.com/sendsms/?waonly=yes";



        const data = {

            recipients: "PHONE_NUMBER",

            message: "YOUR_MESSAGE",

            apikey: "YOUR_API_KEY"

        };



        fetch(url, {

            method: "POST",

            headers: {

                "Content-Type": "application/x-www-form-urlencoded"

            },

            body: new URLSearchParams(data)

        })

        .then(response => response.text())

        .then(result => console.log(result))

        .catch(error => console.error("Error:", error));

This example demonstrates how to send a POST request using the `fetch` API, which is supported in most modern browsers.

Using `XMLHttpRequest`

If you need to support older browsers, you can use the `XMLHttpRequest` object:


        const xhr = new XMLHttpRequest();

        const url = "https://api.smsmobileapi.com/sendsms/?waonly=yes";



        const data = "recipients=PHONE_NUMBER&message=YOUR_MESSAGE&apikey=YOUR_API_KEY";



        xhr.open("POST", url, true);

        xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");



        xhr.onreadystatechange = function() {

            if (xhr.readyState === 4 && xhr.status === 200) {

                console.log(xhr.responseText);

            }

        };



        xhr.send(data);

This example shows how to use `XMLHttpRequest` to send a POST request, providing compatibility with older browsers that may not support `fetch`.

Send WhatsApp

Using the `axios` Library

The `axios` library is a popular HTTP client for Node.js. Here's how you can use it to send a WhatsApp message via the SMSmobileAPI:


        const axios = require('axios');



        const url = 'https://api.smsmobileapi.com/sendsms/?waonly=yes';

        const data = {

            recipients: 'PHONE_NUMBER',

            message: 'YOUR_MESSAGE',

            apikey: 'YOUR_API_KEY'

        };



        axios.post(url, data)

        .then(response => {

            console.log(response.data);

        })

        .catch(error => {

            console.error('Error:', error);

        });

This example demonstrates how to send a POST request using `axios` in Node.js to interact with the SMSmobileAPI.

Send WhatsApp

Using the `Net::HTTP` Library

You can use the `Net::HTTP` library in Ruby to send a WhatsApp message via the SMSmobileAPI:


        require 'net/http'

        require 'uri'



        uri = URI.parse("https://api.smsmobileapi.com/sendsms/?waonly=yes")

        request = Net::HTTP::Post.new(uri)

        request.set_form_data(

            "recipients" => "PHONE_NUMBER",

            "message" => "YOUR_MESSAGE",

            "apikey" => "YOUR_API_KEY"

        )



        req_options = {

            use_ssl: uri.scheme == "https",

        }



        response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|

            http.request(request)

        end



        puts response.body

This example demonstrates how to send a POST request using `Net::HTTP` in Ruby to the SMSmobileAPI.

It is also possible to send a WhatsApp message and an SMS simultaneously.

If you have any questions, suggestions, or need assistance, our team is here to help.
Feel free to reach out to us at api@smsmobileapi.com

SMS Features

WhatsApp Features

General Plugins

Online Store Plugins

API & Developer Docs

Tools & Changes log

WhatsApp Documentation

Send WhatsApp

Resend Message

Synchronization

Retrieve Messages

Authentication

Send WhatsApp API

Endpoint:

Parameters:

Example without media :

Example with media :

Format Text in WhatsApp :

Resend an unsent WhatsApp messages

Endpoint:

Parameter:

Example:

Synchronization to retrieve message

Endpoint:

Parameter:

Example:

Reply :

Retrieve WhatsApp Message

Endpoint:

Parameter:

Example:

Reply :

Authentication

1. API Key Authentication

2. OAuth2 Authentication

Obtaining an Access Token

Using the Access Token:

Which Method Should You Use?

Send WhatsApp message

WSDL URL

Parameters:

Exemple

Send WhatsApp

Basic cURL Command

cURL Example in PHP

Send WhatsApp

Using the `requests` Library

Using the `http.client` Library

Send WhatsApp

Using the `fetch` API

Using `XMLHttpRequest`

Send WhatsApp

Using the `axios` Library

Send WhatsApp

Using the `Net::HTTP` Library