Сообщения
Отправить сообщение
POST
https://app.leadteh.ru/api/v1/sendMessage
Этот метод позволяет отправить сообщение по ID контакта.\ (Отправка в запросе данных контакта должна быть ОТКЛЮЧЕНА)
Query Parameters
Name | Type | Description |
---|---|---|
file | string | URL на файл. |
image | string | URL на картинку. |
contact_id | integer | ID контакта. |
text | string | Сообщение. |
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"
}
501 Отправка для мессенджера еще контакта не реализована.
{
"error": "На данный момент не реализована отправка сообщений в мессенджер контакта (icq)"
}
Отправить сообщение по внешнему ID
POST
https://app.leadteh.ru/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 | Сообщение. |
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
icq
В поле contact_external_id
можно передавать номер телефона не только для мессенджера WhatsApp но и для других, если к контакту привязан номер. Привязка номера может произойти при первом платеже вашего клиента.
Важно
Ваш contact_external_id
должен быть в контактах у бота, для этого напишите боту с нужного мессенджера. Отправка на произвольный номер возможна только через мессенджер WhatsApp через метод sendMessageToWhatsApp
(см. ниже).
Лимиты
Для отправки сообщений установлены следующие ограничения:
Мессенджер | Количество сообщений за 10 сек. |
---|---|
1 | |
Telegram | 10 |
Viber | 10 |
ICQ | 10 |
Отправить сообщение в WhatsApp
POST
https://app.leadteh.ru/api/v1/sendMessageToWhatsApp
Этот метод позволяет отправить сообщение на WhatsApp по номеру телефона.\ (Отправка в запросе данных контакта должна быть ОТКЛЮЧЕНА)
Request Body
Name | Type | Description |
---|---|---|
bot_id | integer | ID бота контакта. |
phone | string | Номер телефона |
text | string | Сообщение |
name | string | Имя контакта, необходимо отправлять когда вы пишите данному контакту в первый раз |
200
{
"data": {
"id": 1,
"phone": "79991234567",
"name": "Иван Иванов",
"messenger": "whatsapp",
"created_at": "2019-05-10T10:38:28+00:00"
}
}
Ограничение: не больше 1-го сообщения в секунду.