Loading...

Описание API

API WAMM.chat для WhatsApp позволяет взаимодействовать со своим аккаунтом WhatsApp из CRM, сайта, 1С или другой системы

Воспользуйтесь нашим API WhatsApp, чтобы выполнять некоторые функции программы без необходимости нажимать кнопки или вводить тексты. Программный интерфейс приложения (API) позволяет отправлять специальные запросы к программе и получать на них ответы. Наш API доступен на любом из платных тарифов - от 1550 рублей в месяц. Не забудьте, что на время тестового периода, в течение 3х дней после регистрации - API WhatsApp является бесплатным! Попробуйте наш WhatsApp API бесплатно.

Так что не ждите, воспользуйтесь нашим API WhatsApp прямо сейчас и сделайте свою работу проще!

С помощью АПИ Ватсап можно делать автоматические рассылки сообщений из других программ, получать тексты и статусы сообщений, добавлять и обновлять контакты. У вас есть возможность отправлять сообщения WhatsApp, отправлять файлы через WhatsApp, отправлять файлы в формате BASE64, получать статус отправленных сообщений, проверять наличие WhatsApp по номеру телефона, получать сообщения через WebHook, получать сообщения WhatsApp и получать сообщения WhatsApp по номеру телефона. Как использовать эти функции? Вы можете найти персональный токен (код) для подключения к API в разделе Настройки, который доступен только пользователям с ролью Администратор.

Имеющиеся сейчас методы API:


👉 Отправка сообщений

Используйте GET-запрос, где номер телефона в международном формате (79001234567 и тп, но может содержать пробелы, скобки, тире и др) и текст в кодировке UTF-8 (может включать ссылки, смайлы). Для переноса текста на новую строку используйте в сообщении символы - %0A

При отправке по API нескольких сообщений, они выстраиваются в очередь отправки с интервалом от 5 до 12 сек (в случайном порядке) между сообщениями. Для тестовых аккаунтов есть ограничение - не более 30 отправленных сообщений по API в день.

Запрос GET: https://wamm.chat/api2/msg_to/токен/?phone=номер-телефона&text=текст-сообщения

Ответ при успехе: JSON: {"err":0,"msg_id":1хххххх}, где msg_id - номер сообщения

Ответ при ошибке: JSON: {"err":"phone fail"}
Варианты ошибок:

  • token fail – ошибка в токене
  • acc not authorized – подключение к WhatsApp не авторизовано
  • phone fail – ошибка в номере телефона
  • no WhatsApp on the number – нет WhatsApp с таким номером
  • phone not checked for WhatsApp, please retry – не проверен номер на наличие WhatsApp
  • text fail – пустой текст
  • text fail, more 1500 – текст слишком большой, превышает 1500 символов


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

Запрос GET: https://wamm.chat/api2/msg_state/токен/?msg_id=номер-сообщения

Ответ при успехе: JSON: {"err":0,"msg_data":{"msg_id":"1хххххх","phone":"79ххххххх","state":"viewed"}}

Ответ при ошибке: JSON: {"err":"msg_id fail"}
Варианты ошибок:

  • token fail – ошибка в токене
  • acc not authorized – подключение к WhatsApp не авторизовано
  • msg_id fail – ошибка в номере
  • msg not be – не найден номер сообщения


👉 API Проверить наличие WhatsApp по номеру телефона

Запрос GET: https://wamm.chat/api2/check_phone/токен/?phone=номер-телефона

Ответ при успехе: JSON: {"err":0,"result":"exists"}
Варианты ответов:

  • exists – есть WhatsApp на номере
  • none – нет Ватсап на номере

Ответ при ошибке: JSON: {"err":"fail execution", "result":"error"}
Варианты ошибок:

  • token fail – ошибка в токене
  • acc not authorized – подключение к WhatsApp не авторизовано
  • fail execution – ошибка проверки, стоит повторить


👉 Отправка файлов / картинок / документов

Используйте GET-запрос, где номер телефона в международном формате (79001234567 и тп, но может содержать пробелы, скобки, тире и др) и URL - публичная ссылка к файлу (доступная из Интернета, вида: https://wamm.chat/i/images/wamm-chat-logo.png).

При отправке по API нескольких сообщений, они выстраиваются в очередь отправки с интервалом от 5 до 12 сек (в случайном порядке) между сообщениями. Для тестовых аккаунтов есть ограничение - не более 30 отправленных сообщений по API в день.

Запрос GET: https://wamm.chat/api2/file_to/токен/?phone=номер-телефона&url=ссылка-на-файл

Ответ при успехе: JSON: {"err":0,"msg_id":1хххххх}, где msg_id - номер сообщения

Ответ при ошибке: JSON: {"err":"phone fail"}
Варианты ошибок:

  • token fail – ошибка в токене
  • acc not authorized – подключение к WhatsApp не авторизовано
  • phone fail – ошибка в номере телефона
  • no WhatsApp on the number – нет WhatsApp с таким номером
  • phone not checked for WhatsApp, please retry – не проверен номер на наличие WhatsApp
  • url fail – пустая ссылка или в ней отсутствует http / https


👉 Отправка файлов / картинок / документов в формате BASE64

В отличие от предыдущего этот метод позволяет отправить файл не предоставляя для него публичную ссылку.

При отправке по API нескольких сообщений, они выстраиваются в очередь отправки с интервалом от 3 до 6 сек между сообщениями. Для тестовых аккаунтов есть ограничение - не более 30 отправленных сообщений по API в день.

Запрос POST: https://wamm.chat/api2/file_from_base64/токен/?phone=номер-телефона

POST:

  • file_name - имя передаваемого файла
  • file_base64 – тело файла в кодировке BASE64

Ответ при успехе: JSON: {"err":0,"msg_id":1хххххх}, где msg_id - номер сообщения

Ответ при ошибке: JSON: {"err":"phone fail"}
Варианты ошибок:

  • token fail – ошибка в токене
  • acc not authorized – подключение к WhatsApp не авторизовано
  • phone fail – ошибка в номере телефона
  • no WhatsApp on the number – нет WhatsApp с таким номером
  • phone not checked for WhatsApp, please retry – не проверен номер на наличие WhatsApp
  • url fail – пустая ссылка или в ней отсутствует http / https


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

Запрос GET: https://wamm.chat/api2/msg_state/токен/?msg_id=номер-сообщения

Ответ при успехе: JSON: {"err":0,"msg_data":{"msg_id":"1хххххх","phone":"79ххххххх","state":"viewed"}}

Ответ при ошибке: JSON: {"err":"msg_id fail"}
Варианты ошибок:

  • token fail – ошибка в токене
  • acc not authorized – подключение к Ватсап не авторизовано
  • msg_id fail – ошибка в номере
  • msg not be – не найден номер сообщения


👉 Получение сообщений через WebHook

В разделе Настройки > Данные и API > Webhook URL вы можете задать URL - своего сервера, куда будут отправляться входящие и исходящие сообщения из нашего сервиса в формате JSON. Сообщения будут отправляться в Online-режиме без задержек, вы сможете их сразу же использовать и обрабатывать.

Отправляются POST-запросы последовательно. Ваш сервис должен ответить кодом 200, в противном случае мы повторим отправку через 15 секунд.

Формат отправляемых запросов: JSON: {"tip":"msg","msg_data":{"msg_id":1хххххх,"from_api":0,"from_me":0,"phone_acc":"79ххххххх","phone":"79xxxxxxxxx","chat_name":"Group chat 17.10.2022","tip_msg":"textMessage","msg_text":"Супер","msg_link":null,"date_ins":"2022-11-21 12:35:29","state":"received"}}

Описание переменных:

  • msg_id - номер сообщения
  • from_me - входящее (0) или исходящее (1) сообщение
  • from_api - отправленное из API или нет (0/1)
  • phone_acc - номер телефона, подключенного к WAMM
  • phone - номер телефона получателя
  • chat_name - имя контакта
  • tip_msg - тип сообщения: текст – textMessage, file_link – файл/картинка/голосовое и т.п.
  • msg_text - текст сообщения
  • msg_link - ссылка на файл
  • date_ins - дата отправки/получения
  • state - статус сообщения (sending, viewed, received и другие)


👉 Получение статусов отправленных сообщений через WebHook

Формат отправляемых запросов: JSON: {"tip":"msg_state","msg_data":{"msg_id":"1хххххх","date_upd":"2022-12-11 22:46:03","state":"delivered"}}

Описание переменных:

  • msg_id - номер сообщения
  • date_upd - дата получения статуса
  • state - статус сообщения (sending, viewed, received и другие)


👉 Получение сообщений

Этой функцией можно получить до 100 последних исходящих и входящих текстовых сообщений

Запрос GET: https://wamm.chat/api2/msg_get_last/токен/?col=кол-во(1-100)

В запросе также можно указать необязательный GET-параметр from_me=0 или from_me=1, который позволит вывести не все последние сообщения, а лишь отправленные (1) или полученные (0)

Ответ при успехе: JSON: {"err":0,"msg_data":[{"msg_id":"1xxxxxx","from_me":"1","phone":"79xxxxxxxxx","chat_name":"Олег Иванов","tip_msg":"textMessage","msg_text":"текст сообщения","msg_link":"URL","date_ins":"2021-01-24 19:52:00","date_upd":"2021-01-24 19:52:22","state":"delivered"},…….. }]}

Описание переменных:

  • msg_id - номер сообщения
  • from_me - входящее (0) или исходящее (1) сообщение
  • phone - номер телефона
  • chat_name - имя контакта
  • tip_msg - тип сообщения: текст – textMessage, file_link – файл/картинка/голосовое и т.п.
  • msg_text - текст сообщения
  • msg_link - ссылка на файл
  • date_ins - дата отправки/получения
  • state - статус сообщения (sending, viewed, received и другие)

Ответ при ошибке: JSON: {"err":"col fail or more 100"}
Варианты ошибок:

  • token fail – ошибка в токене
  • acc not authorized – подключение к WhatsApp не авторизовано
  • col fail or more 100 – ошибка в кол-ве или превышает 100
  • msgs not be – не найдены сообщения


👉 Получение сообщений по номеру телефона

Этой функцией можно получить до 100 последних исходящих и входящих текстовых сообщений по конкретному номеру телефона

Запрос GET: https://wamm.chat/api2/msg_get/токен/?phone=телефон&col=кол-во(1-100)

Ответ при успехе: JSON: {"err":0,"msg_data":[{"msg_id":"1xxxxxx","from_me":"1","phone":"79xxxxxxxxx","chat_name":"Олег Иванов","tip_msg":"textMessage","msg_text":"текст сообщения","msg_link":"URL","date_ins":"2021-01-24 19:52:00","date_upd":"2021-01-24 19:52:22","state":"delivered"},…….. }]}

Описание переменных:

  • msg_id - номер сообщения
  • from_me - входящее (0) или исходящее (1) сообщение
  • phone - номер телефона
  • chat_name - имя контакта
  • tip_msg - тип сообщения: текст – textMessage, file_link – файл/картинка/голосовое и т.п.
  • msg_text - текст сообщения
  • msg_link - ссылка на файл
  • date_ins - дата отправки/получения
  • state - статус сообщения (sending, viewed, received и другие)

Ответ при ошибке: JSON: {"err":"col fail or more 100"}
Варианты ошибок:

  • token fail – ошибка в токене
  • acc not authorized – подключение к WhatsApp не авторизовано
  • col fail or more 100 – ошибка в кол-ве или превышает 100
  • msgs not be – не найдены сообщения
  • phone fail – ошибка в номере телефона


👉 Добавление и обновление контактов

Этот запрос добавляет контакт в WAMM.chat или обновляет имя, если существует.

Запрос GET: https://wamm.chat/api2/contact_to/токен/?phone=номер-телефона&name=имя контакта

Запрос GET: https://wamm.chat/api2/contact_to/токен/?phone=номер-телефона&name=имя контакта&info=Заметка, примечание к контакту&email=e-mail&web=URL

Где, параметры info, email, web - необязательные, их можно не отправлять в запросе

Ответ при успехе: JSON: {"err":0,"result":"insert"} или JSON: {"err":0,"result":"update"}

Ответ при ошибке: JSON: {"err":"phone fail"}
Варианты ошибок:

  • token fail – ошибка в токене
  • acc not authorized – подключение к WhatsApp не авторизовано
  • phone fail – ошибка в номере телефона
  • no WhatsApp on the number – нет WhatsApp с таким номером
  • phone not checked for WhatsApp, please retry – не проверен номер на наличие WhatsApp
  • name fail – не указано имя
  • name fail, more 250 – имя слишком большое, превышает 250 символов
  • web fail, more 150 – URL слишком большое, превышает 150 символов
  • email fail, more 150 – email слишком большое, превышает 150 символов


👉 Удаление контактов

Этот запрос удаляет контакт в WAMM.chat, при этом в WhatsApp на смартфоне он остаётся.

Запрос GET: https://wamm.chat/api2/contact_delete/токен/?phone=номер-телефона

Ответ при успехе: JSON: {"err":0,"result":"delete"}

Ответ при ошибке: JSON: {"err":"phone fail"}
Варианты ошибок:

  • token fail – ошибка в токене
  • acc not authorized – подключение к WhatsApp не авторизовано
  • phone fail – ошибка в номере телефона
  • phone not found – не найден телефон в контактах


👉 Смайлы

Текст сообщения должен быть в UTF-8 и он позволяет вставить смайлы, как отдельные символы: 🤗💐😂🤩😭 и тд. Если вы используете системы, которые по тем или иным причинам не могут отправить смайлы, то можете использовать спецсимволы, которые будут заменены на смайлы:

Смайл Код
🤗 :sm01:
💐 :sm02:
😂 :sm03:
🤩 :sm04:
😭 :sm05:
😤 :sm06:
🤝 :sm07:
😃 :sm08:
😉 :sm09:
😍 :sm10:
😘 :sm11:
😷 :sm12:
😕 :sm13:
🙏 :sm14:
👉 :sm15:
👍 :sm16:
💐 :sm17:
🔥 :sm18:
🕒 :sm19:
🎁 :sm20:
📺 :sm21:
:sm22:
🚀 :sm23:
💰 :sm24:
💜 :sm25:
📋 :sm26:

Как начать использовать

Зарегистрируетесь, подключите свои мессенджеры и работайте в WAMM.сhat!
На регистрацию и настройку не более 5 минут!
Первые 3 дня всё бесплатно!