For the complete documentation index, see llms.txt. This page is also available as Markdown.

Сообщения

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

POST https://app.onebot.tech/api/v1/sendMessage

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

Query Parameters

Name
Type
Description

file

String

URL на файл

image

String

URL на картинку

contact_id

Integer

ID контакта

text

String

Сообщение

{
    "success": true
}
{
    "message": "Forbidden"
}
{
  "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 не указано."
    ]
  }
}

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

POST https://app.onebot.tech/api/v1/sendMessage

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

Query Parameters

Name
Type
Description

file

String

URL на файл

image

String

URL на картинку

bot_id

Integer

ID бота контакта

contact_external_id

String

Номер телефона или внешний id контакта в мессенджере

messenger

String

ID мессенджера

text

String

Сообщение

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

  • whatsapp

  • telegram

  • viber

  • icq

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

Лимиты:

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

Мессенджер
Количество сообщений за 10 сек.

WhatsApp

1

Telegram

10

Viber

10

ICQ

10

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

POST https://app.onebot.tech/api/v1/sendMessageToWhatsApp

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

Request Body

Name
Type
Description

bot_id

Integer

ID бота контакта

phone

String

Номер телефона

text

String

Сообщение

name

String

Имя контакта, необходимо отправлять когда ты пишешь данному контакту в первый раз

Последнее обновление