Главная — Разработчикам

Методы работы с рассылками

POST​/v2​/bulk
Отправка пачки сообщений

Отправить пачку сообщений и получить идентификаторы сообщений максимум 10 000

Parameters

Name Description
X-Auth-Token
string
( header )

Токен авторизации

body
( body )
{
  "typeSending": [
    "viber"
  ],
  "smsSenderName": "string",
  "isTest": true,
  "channelViber": "string",
  "channelVk": "string",
  "countryCode": 0,
  "ttl": {
    "total": 0,
    "relation": {
      "public": 0,
      "viber": 0,
      "vk": 0
    }
  },
  "phonebook": [
    {
      "number": 375296890043,
      "image": "http://www.host.com/image.png",
      "link": "http://host.com",
      "messageViber": "string",
      "messageSms": "string",
      "messageVk": "string",
      "messagePublic": "string",
      "button": "string"
    }
  ]
}

Responses

Code Description
200

Сообщения успешно поставлены в очередь

{
  "code": 200,
  "meta": {},
  "data": [
    {
      "number": 0,
      "id": "string",
      "error": 0
    }
  ]
}
400

Ошибка в запросе

{
  "errorCode": 400,
  "errorMessage": "string"
}
500

Внутренняя ошибка сервера

POST​/v2​/bulk​/message_status
Запрос статусов максимум 100 за раз

Parameters

Name Description
X-Auth-Token
string
( header )

Токен авторизации

body
( body )
{
  "ids": [
    "34433453333"
  ]
}

Responses

Code Description
200

Текущие статусы по запрошенным сообщениям

{
  "code": 200,
  "meta": {},
  "data": [
    {
      "status": "delivered",
      "msg_id": "string",
      "status_date": "string",
      "type": "viber"
    }
  ]
}
400

Слишком много идентификаторов в одном запросе

403

Доступ к запрашиваемым данным запрещен

500

Внутренняя ошибка сервера

POST​/callbackUrl
Уведомление об изменении статуса

Parameters

Name Description
X-Auth-Token
string
( header )

Токен авторизации

body
( body )
{
  "status": "delivered",
  "msg_id": "string",
  "status_date": "string",
  "type": "viber"
}

Responses

Code Description
200

Статус успешно обработан