Надіслати WhatsApp
Повторно надіслати повідомлення
Синхронізація
Отримати повідомлення
Аутентифікація
|
Надіслати WhatsApp API
Ця кінцева точка API використовується для надсилання повідомлень WhatsApp.
Кінцева точка:
GET POST https://api.smsmobileapi.com/sendsms
Параметри:
- apikey: Ваш унікальний ключ API.
- 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: Повідомлення для надсилання (можливе кілька рядків).
- 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, gif, bmp, tiff, svg, webp, ico, heic, jfif
- waonly: має мати значення так -> Необхідно вказати, що потрібно надіслати лише одне повідомлення WhatsApp
Приклад без носія:
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:
-
Курсив: Use underscores → _text_
-
Жирний: Use asterisks → *text*
-
Закреслено: Use tildes → ~text~
-
Моноширинні: Use backticks → ```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 (required): Ключ API, який ви маєте або отримаєте.
- before (optional): Передайте мітку часу як параметр і відобразіть записи під цією міткою часу.
- date (optional): (рррр-мм-дд) отримати всі записи на основі дати.
приклад:
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.
|