База знаний BotVsem ⤵

< Все темы
Печать

Сообщения

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

https://app.botvsem.ru/api/v1/sendMessage

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

Query Parameters

file
OPTIONAL
string

 

URL на файл.

image
OPTIONAL
string

 

URL на картинку.

contact_id
REQUIRED
integer

 

ID контакта.

200: OK
Запрос успешно обработан
 
{
"success": true
}
403: Forbidden
Доступ запрещен.
 
{
"message": "Forbidden"
}
422: Unprocessable Entity
Переданы некорректные данные.
{
"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: Too Many Requests
Превышен лимит отправки сообщений.
{
"error": "Достигнут лимит отправки сообщений для whatsapp"
}
501: Not Implemented
Отправка для мессенджера еще контакта не реализована.
{
"error": "На данный момент не реализована отправка сообщений в мессенджер контакта (icq)"
}
text
OPTIONAL
string

 

Сообщение.

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

https://app.botvsem.ru/api/v1/sendMessage

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

Query Parameters

file
OPTIONAL
string

 

URL на файл.

image
OPTIONAL
string

 

URL на картинку.

bot_id
REQUIRED
integer

 

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

200: OK
Запрос успешно обработан
 
{
"success": true
}
403: Forbidden
Доступ запрещен.
 
{
"message": "Forbidden"
}
422: Unprocessable Entity
Переданы некорректные данные.
{
"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: Too Many Requests
Превышен лимит отправки сообщений.
{
"error": "Достигнут лимит отправки сообщений для whatsapp"
}
contact_external_id
REQUIRED
string

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

messenger
REQUIRED
string

 

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

text
OPTIONAL
string

 

Сообщение.

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

  • - whatsapp
  • - telegram
  • - viber
  • - ВКонтакте

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

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

Лимиты

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

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

https://app.botvsem.ru/api/v1/sendMessageToWhatsApp

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

Form Data Parameters

bot_id
REQUIRED
integer

 

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

phone
REQUIRED
string

 

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

text
REQUIRED
string

 

Сообщение

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

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

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

Оглавление