Розробник DOC WhatsApp

Документація WhatsApp

Ця документація стосується надсилання й отримання повідомлень WhatsApp.

Натисніть тут, щоб дізнатися більше про всі функції, які пропонує наша інтеграція WhatsApp.

У SMSmobileAPI ми прагнемо зробити наш API максимально сумісним із будь-якою архітектурою чи платформою.
Незалежно від того, чи використовуєте ви REST, SOAP, cURL або різні мови програмування, як-от Python, JavaScript, PHP тощо, наш API створено для бездоганної інтеграції у ваші проекти.

У нас також є готові до використання плагіни для рішень електронної комерції та програмного забезпечення. Натисніть тут, щоб дізнатися про них.

API REST

cURL

JavaScript

Python

Node.js

рубін

WSDL

Надіслати WhatsApp API

Ця кінцева точка API використовується для надсилання повідомлень WhatsApp.

Кінцева точка:

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

Параметри:

Параметр	опис
apikey	Обов'язковий Ваш унікальний ключ API.
recipients	Обов'язковий Номер телефону одержувача (Номер має бути доступний у WhatsApp). Введіть номер телефону, починаючи з коду країни (без «+» і без «00»), а потім решту номера. приклад: 191728660
message	Обов'язковий Повідомлення для надсилання (можливе кілька рядків).
waonly	Обов'язковий Повинен мати значення так → Необхідно вказати, що потрібно надіслати лише одне повідомлення WhatsApp.
url_media	Пряма URL-адреса медіафайлу, який ви хочете надіслати через WhatsApp. Треба почати з https:// і вкажіть на дійсний PDF, док або зображення файл. Файл має бути загальнодоступним без автентифікації. Підтримувані формати: Документи: pdf, xml, doc, docx, odt, rtf, txt, tex, xls, xlsx, csv, ods, ppt, pptx, odp, zip, rar, 7z, tar, gz Зображення: jpg, jpeg, png
url_media_shorted	Якщо значення є так, і встановлено [pdf_with_image=yes], посилання для завантаження PDF-файлу відображатиметься через коротку URL-адресу.
pdf_with_image	Якщо значення є так, для попереднього перегляду PDF-файлу буде показано супроводжувати повідомлення (лише якщо файл PDF).
encrypt_message	так = Повідомлення буде зашифровано, коли його прочитає одержувач. Одержувач повинен буде ввести унікальний ключ, щоб розшифрувати повідомлення. Докладніше про шифрування повідомлень

Приклад без носія:


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

Приклад із медіа:


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

Форматувати текст у WhatsApp:

Курсив: Використовуйте підкреслення → _text_
Жирний: Використовуйте зірочки → *текст*
Закреслене: Використовуйте тильди → ~текст~
Моноширинні: Використовуйте зворотні галочки → ```текст```

Наприклад: _Hello_ world, How * are* you ~ today~ from ```SMSMobileAPI```

Повторно надіслати ненадіслане повідомлення WhatsApp

Ця кінцева точка API використовується для повторного надсилання ненадісланого повідомлення (лише якщо повідомлення має статус помилки)

Кінцева точка:

ОТРИМАТИ ПОСТ https://api.smsmobileapi.com/resendwa/

Параметр:

Параметр	опис
guid	Обов'язковий GUID повідомлення, яке потрібно надіслати повторно.

приклад:


        ОТРИМАТИ https://api.smsmobileapi.com/resendwa/?apikey=YOUR_API_KEY&guid=GUID_OF_THE_MESSAGE

Синхронізація для отримання повідомлення

Ця кінцева точка API використовується для надсилання запиту на синхронізацію та отримання повідомлень WhatsApp.
Цей крок є обов’язковим і має бути виконаний перед викликом кінцевої точки, яка отримує повідомлення.

УВАГА: Синхронізація суворо потрібна лише для функції отримання повідомлень. Не починайте синхронізацію, щоб надіслати повідомлення.

Кінцева точка:

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

Параметр:

Параметр	опис
apikey (required)	Обов'язковий Ключ API, який ви маєте або отримаєте.

приклад:


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

Відповісти:



{


 "помилка": "0",

   "messages": "синхронізовано",

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

  "expire_at_unix": "1741692420",


 

}

Отримати повідомлення WhatsApp

Ця кінцева точка API використовується для отримання отриманих повідомлень WhatsApp.

Кінцева точка:

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

Параметр:

Параметр	опис
apikey	Обов'язковий Ключ API, який ви маєте або отримаєте.
before	Передайте мітку часу як параметр і відобразіть записи під цією міткою часу.
date	(рррр-мм-дд) Отримати всі записи на основі дати.
message_type	Залиште порожнім, щоб побачити всі (текстові та звукові повідомлення) використання `текст` щоб переглядати лише текстові повідомлення використання `аудіо` щоб побачити лише звукові повідомлення, перетворені на текст

приклад:


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

Відповісти:



{


  "дата": "2025-03-11",

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

  "timestamp": "1741692420",

  "номер": "19176728660",

  "contact": "Smsmobileapi",

  "message": "Чи можете ви сказати мені, коли я отримаю своє замовлення?",

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

  
  "більше": {

    "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": "Ваше замовлення #576 буде відправлено завтра."

	
  }

    
  
}

Аутентифікація

API SMSMobile підтримує два методи автентифікації: за допомогою простого ключа API або протоколу OAuth2 з ідентифікатором клієнта та секретом клієнта.

1. Аутентифікація ключа API

Щоб надсилати або отримувати повідомлення WhatsApp через наш API, потрібна автентифікація за допомогою ключа API. Це забезпечує безпечний та авторизований доступ до служби обміну повідомленнями. Просто додайте свій ключ API до запиту для автентифікації та почніть безперешкодно надсилати повідомлення.

2. Автентифікація OAuth2

OAuth2 забезпечує більш безпечний і масштабований метод автентифікації.
Вам потрібно буде використовувати ідентифікатор клієнта та секрет клієнта, щоб отримати маркер доступу, який потім слід включити у ваші запити API за допомогою Авторизація заголовок.

client_id і client_secret доступні на панелі інструментів.

Отримання маркера доступу

Щоб отримати маркер доступу, надішліть запит POST кінцевій точці маркера з ідентифікатором клієнта та секретом клієнта.


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"

Використання маркера доступу:

Отримавши маркер доступу, додайте його до Авторизація заголовок ваших запитів API:


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.

Надіслати повідомлення WhatsApp

WSDL URL

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

Параметри:

- recipients: Мобільний номер одержувача.

- message: Повідомлення для надсилання.

- apikey: Ключ API, який ви маєте або отримаєте.

- waonly: має мати значення так -> Необхідно вказати, що потрібно надіслати лише одне повідомлення WhatsApp.

Приклад


                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);

Надіслати WhatsApp

Базова команда cURL

Ви можете використовувати таку команду cURL, щоб надіслати повідомлення WhatsApp через 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 у PHP

Якщо ви використовуєте PHP, ось як ви можете надіслати повідомлення WhatsApp за допомогою 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;

        

        ?>

Цей приклад PHP демонструє, як надіслати запит POST за допомогою cURL до SMSmobileAPI, передаючи необхідні параметри як асоціативний масив.

Надіслати WhatsApp

Використовуйте наш офіційний модуль Python: https://smsmobileapi.com/python/
або скористайтеся ручним способом...

Використання бібліотеки запитів

Бібліотека `requests` — популярна та проста бібліотека HTTP для Python. Ось як ви можете використовувати його для надсилання повідомлення WhatsApp через 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)

Цей приклад демонструє простий запит POST до SMSmobileAPI, надсилаючи повідомлення WhatsApp на певний номер телефону.

Використання бібліотеки `http.client`

Бібліотека `http.client` входить до стандартної бібліотеки Python і також може використовуватися для взаємодії з вашим 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()

У цьому прикладі показано, як використовувати бібліотеку `http.client` для надсилання запиту POST до API. Параметри кодуються в URL-адресі та надсилаються з відповідними заголовками.

Надіслати WhatsApp

Використання API `fetch`

API `fetch` — це сучасний і універсальний спосіб робити HTTP-запити в JavaScript. Ось як ви можете використовувати його для надсилання повідомлення WhatsApp через 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));

Цей приклад демонструє, як надіслати запит POST за допомогою API `fetch`, який підтримується в більшості сучасних браузерів.

Використання `XMLHttpRequest`

Якщо вам потрібна підтримка старих браузерів, ви можете використовувати об’єкт `XMLHttpRequest`:


        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);

У цьому прикладі показано, як використовувати `XMLHttpRequest` для надсилання запиту POST, забезпечуючи сумісність зі старими браузерами, які можуть не підтримувати `fetch`.

Надіслати WhatsApp

Використання бібліотеки `axios`

Бібліотека `axios` є популярним HTTP-клієнтом для Node.js. Ось як ви можете використовувати його для надсилання повідомлення WhatsApp через 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);

        });

Цей приклад демонструє, як надіслати запит POST за допомогою `axios` у Node.js для взаємодії з SMSmobileAPI.

Надіслати WhatsApp

Використання бібліотеки `Net::HTTP`

Ви можете використовувати бібліотеку `Net::HTTP` у Ruby, щоб надіслати повідомлення WhatsApp через 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

Цей приклад демонструє, як надіслати запит POST за допомогою `Net::HTTP` у Ruby до SMSmobileAPI.

Це також можливо надсилати повідомлення WhatsApp і SMS одночасно.

Якщо у вас виникли запитання, пропозиції чи потрібна допомога, наша команда готова допомогти.
Не соромтеся звертатися до нас за адресою api@smsmobileapi.com

Функції SMS

Функції WhatsApp

Загальні плагіни

Плагіни Інтернет-магазину

API та документи для розробників

Інструменти та журнал змін

Документація WhatsApp

Надіслати WhatsApp

Повторно надіслати повідомлення

Синхронізація

Отримати повідомлення

Аутентифікація

Надіслати WhatsApp API

Кінцева точка:

Параметри:

Приклад без носія:

Приклад із медіа:

Форматувати текст у WhatsApp:

Повторно надіслати ненадіслане повідомлення WhatsApp

Кінцева точка:

Параметр:

приклад:

Синхронізація для отримання повідомлення

Кінцева точка:

Параметр:

приклад:

Відповісти:

Отримати повідомлення WhatsApp

Кінцева точка:

Параметр:

приклад:

Відповісти:

Аутентифікація

1. Аутентифікація ключа API

2. Автентифікація OAuth2

Отримання маркера доступу

Використання маркера доступу:

Which Method Should You Use?

Надіслати повідомлення WhatsApp

WSDL URL

Параметри:

Приклад

Надіслати WhatsApp

Базова команда cURL

Приклад cURL у PHP

Надіслати WhatsApp

Використання бібліотеки запитів

Використання бібліотеки `http.client`

Надіслати WhatsApp

Використання API `fetch`

Використання `XMLHttpRequest`

Надіслати WhatsApp

Використання бібліотеки `axios`

Надіслати WhatsApp

Використання бібліотеки `Net::HTTP`