Dev DOC WhatsApp - SMSMobileAPI

WhatsApp-документация

Данная документация посвящена отправке и получению сообщений WhatsApp.

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

В SMSmobileAPI мы стремимся сделать наш API максимально совместимым с любой архитектурой или платформой.
Независимо от того, используете ли вы REST, SOAP, cURL или различные языки программирования, такие как Python, JavaScript, PHP и другие, наш API разработан для бесшовной интеграции в ваши проекты.

У нас также есть готовые к использованию плагины для решений и программного обеспечения для электронной коммерции. Нажмите здесь, чтобы узнать о них.

API-интерфейс REST

cURL

JavaScript

Питон

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	да = Сообщение будет зашифровано при прочтении получателем. Получателю необходимо будет ввести уникальный ключ для расшифровки сообщения. Узнайте больше о шифровании сообщений
contactGroup	Введите GUID группы (доступен на панели управления) при редактировании группы контактов.

Пример без медиа:


        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:

Курсив: Используйте подчеркивания → _текст_
Смелый: Используйте звездочки → *текст*
Зачеркивание: Используйте тильды → ~текст~
Моноширинный: Используйте обратные кавычки → ```текст```

Например: _Привет_ мир, Как *ты* ~сегодня~ от ```SMSMobileAPI```

Повторно отправить неотправленные сообщения WhatsApp

Эта конечная точка API используется для повторной отправки неотправленного сообщения (только если сообщение имеет статус ошибки).

Конечная точка:

ПОЛУЧАТЬ ПОЧТА https://api.smsmobileapi.com/resendwa/

Параметр:

Параметр	Описание
guid	Необходимый GUID сообщения, которое необходимо отправить повторно.

Пример:


        ПОЛУЧИТЬ https://api.smsmobileapi.com/resendwa/?apikey=ВАШ_КЛЮЧ_API&guid=GUID_СООБЩЕНИЯ

Синхронизация для извлечения сообщения

Эта конечная точка API используется для отправки запроса на синхронизацию и извлечение сообщений WhatsApp.
Этот шаг является обязательным и должен быть выполнен перед вызовом конечной точки, которая извлекает сообщения.

Предупреждение: Синхронизация строго требуется только для функции извлечения сообщений. Не запускайте синхронизацию для отправки сообщения.

Конечная точка:

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

Параметр:

Параметр	Описание
apikey (required)	Необходимый API-ключ, который у вас есть или который вы получите.

Пример:


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

Отвечать :



{


 "ошибка": "0",

   "сообщения": "синхронизировано",

  "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",

  "час": "12:27:00",

  "отметка времени": "1741692420",

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

  "контакт": "Smsmobileapi",

  "сообщение": "Можете ли вы сказать мне, когда я получу свой заказ?",

  "руководство": "652fcfc0-12a8-46f5-b5ba-9391135b8b4c",

  
  "более": {

    "автоответ": "1",

    "перевод_на_электронную_почту": "1",

    "chatgpt_reply": "1"

	
  },


  "чатгпт": {

    "prompt_tokens": "900",

    "completion_tokens": "10",

    "всего_токенов": "910",

    "total_tokens_cost": "0.182"

	 "response": "Ваш заказ #576 будет отправлен завтра."

	
  }

    
  
}

Проверить номер на WhatsApp

Эта конечная точка API позволяет проверить, доступен ли номер телефона в сети WhatsApp.

Конечная точка:

GET https://api.smsmobileapi.com/whatsapp/checknumber/

Параметр:

Параметр	Описание
apikey	Необходимый Ваш apikey
recipients	Необходимый Номер телефона для проверки

Пример:


        GET https://api.smsmobileapi.com/whatsapp/checknumber/?recipients=_YOUR_API_KEY_&apikey=_PHONE_NUMBER_

Отвечать :



{


  "контакт_найден_в_whatsapp": "да",

  "получатели": 19176728660,

 


  
  
}

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

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

URL-адрес WSDL

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

Для отправки сообщения WhatsApp через SMSmobileAPI можно использовать следующую команду cURL:


        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`

Библиотека `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

Возможности СМС

Функции WhatsApp

Общие плагины

Плагины для интернет-магазинов

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

Журнал инструментов и изменений

WhatsApp-документация

Отправить WhatsApp

Отправить сообщение повторно

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

Получить сообщения

Контрольный номер

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

Отправить WhatsApp API

Конечная точка:

Параметры:

Пример без медиа:

Пример с медиа:

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

Повторно отправить неотправленные сообщения WhatsApp

Конечная точка:

Параметр:

Пример:

Синхронизация для извлечения сообщения

Конечная точка:

Параметр:

Пример:

Отвечать :

Получить сообщение WhatsApp

Конечная точка:

Параметр:

Пример:

Отвечать :

Проверить номер на WhatsApp

Конечная точка:

Параметр:

Пример:

Отвечать :

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

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

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

Получение токена доступа

Использование токена доступа:

Which Method Should You Use?

Отправить сообщение WhatsApp

URL-адрес WSDL

Параметры:

Пример

Отправить WhatsApp

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

Пример cURL на PHP

Отправить WhatsApp

Использование библиотеки `requests`

Использование библиотеки `http.client`

Отправить WhatsApp

Использование API `fetch`

Использование `XMLHttpRequest`

Отправить WhatsApp

Использование библиотеки `axios`

Отправить WhatsApp

Использование библиотеки `Net::HTTP`