Сообщения

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

POST https://app.jetbot24.ru/api/v1/sendMessage

Этот метод позволяет отправить сообщение по id пользователя на платформе JetBot (параметр contact_id)

Request Body

Name	Type	Description
api_token*	string	api токен вашего аккаунта
contact_id*	integer	id пользователя на платформе JetBot
file	string	URL на файл. Обязательный параметр когда image и text не переданы.
image	string	URL на картинку. Обязательный параметр когда file и text не переданы.
text	string	Сообщение. Обязательный параметр когда file и image не переданы.

Response

200 Cообщение успешно отправлено

{
    "success": true
}

403 Доступ запрещен

{
    "message": "Forbidden"
}

422 Переданные данные некорректны

{
  "message": "The given data was invalid.",
  "errors": {
    "contact_id": [
      "Поле contact id обязательно для заполнения, когда messenger \/ bot id \/ contact external id не указано."
    ],
    "text": [
      "Поле text обязательно для заполнения, когда ни одно из image \/ file не указано."
    ],
    "image": [
      "Поле image обязательно для заполнения, когда ни одно из text \/ file не указано."
    ],
    "file": [
      "Поле file обязательно для заполнения, когда ни одно из text \/ image не указано."
    ],
    "messenger": [
      "Поле messenger обязательно для заполнения, когда contact id не указано."
    ],
    "bot_id": [
      "Поле bot id обязательно для заполнения, когда contact id не указано."
    ],
    "contact_external_id": [
      "Поле contact external id обязательно для заполнения, когда contact id не указано."
    ]
  }
}

422 Неверный api токен

{
    "error": "Unauthenticated."
}

429 Превышен лимит

{
    "error": "Достигнут лимит отправки сообщений для whatsapp"
}

Отправить сообщение по внешнему ID

POST https://app.jetbot24.ru/api/v1/sendMessage

Этот метод позволяет отправить сообщение по номеру телефона или по внешнему ID контакта в мессенджере или социальной сети.

Request Body

Name	Type	Description
api_token*	string	api токен вашего аккаунта
file	string	URL на файл. Обязательный параметр когда image и text не переданы.
image	string	URL на картинку. Обязательный параметр когда file и text не переданы.
text	string	Сообщение. Обязательный параметр когда file и image не переданы.
bot_id*	integer	ID бота контакта
contact_external_id*	string	Номер телефона или внешний id контакта в мессенджере.
messenger*	string	ID мессенджера.

Response

200 Сообщение успешно отправлено

{
    "success": true
}

403 Доступ запрещен

{
  "message": "Forbidden"
}

422 Переданные данные некорректны

{
  "message": "The given data was invalid.",
  "errors": {
    "contact_id": [
      "Поле contact id обязательно для заполнения, когда messenger \/ bot id \/ contact external id не указано."
    ],
    "text": [
      "Поле text обязательно для заполнения, когда ни одно из image \/ file не указано."
    ],
    "image": [
      "Поле image обязательно для заполнения, когда ни одно из text \/ file не указано."
    ],
    "file": [
      "Поле file обязательно для заполнения, когда ни одно из text \/ image не указано."
    ],
    "messenger": [
      "Поле messenger обязательно для заполнения, когда contact id не указано."
    ],
    "bot_id": [
      "Поле bot id обязательно для заполнения, когда contact id не указано."
    ],
    "contact_external_id": [
      "Поле contact external id обязательно для заполнения, когда contact id не указано."
    ]
  }
}

429 Превышен лимит отправки сообщений

{
    "error": "Достигнут лимит отправки сообщений для whatsapp"
}

Поле messenger может принимать следующие значения:

• whatsapp

• telegram

• viber

В поле contact_external_id можно передавать номер телефона не только для мессенджера WhatsApp но и для других, если к контакту привязан номер. Привязка номера может произойти при первом платеже вашего клиента.

Вашcontact_external_idдолжен быть в контактах у бота, для этого напишите боту с нужного мессенджера. Отправка на произвольный номер возможна только через мессенджер WhatsApp через метод sendMessageToWhatsApp (см. ниже).

Лимиты

Для отправки сообщений установлены следующие ограничения:

Мессенджер	Количество сообщений за 10 секунд
WhatsApp	1
Telegram	10
Viber	10

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

POST https://app.jetbot24.ru/api/v1/sendMessageToWhatsApp

Этот метод позволяет отправить сообщение на WhatsApp по номеру телефона.

Ограничение: не больше 1-го сообщения в секунду.

Request Body

Name	Type	Description
api_token*	string	api токен вашего аккаунта
bot_id*	integer	ID бота контакта
phone*	string	Номер телефона
text*	string	Сообщение
name	string	Имя контакта, необходимо отправлять когда вы пишите данному контакту в первый раз

Response

200

{
  "data": {
          "id": 1,
          "phone": "79991234567",
          "name": "Иван Иванов",
          "messenger": "whatsapp",
          "created_at": "2024-05-10T10:38:28+00:00"
    }
}