add

Создает виртуальные визитки.

  1. Ограничения
  2. Запрос
  3. Ответ
  4. Примеры

Ограничения

Не более 1000 визиток в одном вызове метода.

Нельзя добавить визитку, если кампания находится в архиве.

Если у визиток все поля идентичны, то будет создана только одна визитка.

Запрос

Структура запроса в формате JSON:

{
  "method": "add",
  "params": { /* params */
    "VCards": [{  /* VCardAddItem */
      "CampaignId": (long), /* required */
      "Country": (string), /* required */
      "City": (string), /* required */
      "CompanyName": (string), /* required */
      "WorkTime": (string), /* required */
      "Phone": {  /* Phone */
        "CountryCode": (string), /* required */
        "CityCode": (string), /* required */
        "PhoneNumber": (string), /* required */
        "Extension": (string)
      }, /* required */
      "Street": (string),
      "House": (string),
      "Building": (string),
      "Apartment": (string),
      "InstantMessenger": {  /* InstantMessenger */
        "MessengerClient": (string), /* required */
        "MessengerLogin": (string) /* required */
      },
      "ExtraMessage": (string),
      "ContactEmail": (string),
      "Ogrn": (string),
      "MetroStationId": (long),
      "PointOnMap": {  /* MapPoint */ 
        "X": (decimal), /* required */
        "Y": (decimal), /* required */
        "X1": (decimal), /* required */
        "Y1": (decimal), /* required */
        "X2": (decimal), /* required */
        "Y2": (decimal) /* required */
      },
      "ContactPerson": (string)
    }, ... ] /* required */
  }
}
ПараметрТипОписаниеОбяза-тельный
Структура params (для JSON) / AddRequest (для SOAP)
VCardsarray of VCardAddItemВизитки, которые требуется добавить.Да
Структура VCardAddItem
CampaignIdlong

Идентификатор кампании.

Да
Countrystring

Страна. Не более 50 символов.

Да
Citystring

Город. Не более 55 символов.

Да
CompanyNamestring

Название организации. Не более 255 символов.

Да
WorkTimestring

Режим работы организации или режим обслуживания клиентов. Задается как строка, в которой указан диапазон дней недели, рабочих часов и минут.

Дни недели обозначаются цифрами от 0 до 6, где 0 — понедельник, 6 — воскресенье.

Минуты задают кратно 15: 0, 15, 30 или 45.

Формат строки: "день_с;день_по;час_с;минуты_с;час_до;мин_до".

Например, строка "0;4;10;0;18;0" задает такой режим:

0;4 — с понедельника по пятницу;

10;0 — с 10 часов 0 минут;

18;0 — до 18 часов 0 минут.

Режим может состоять из нескольких строк указанного формата, например: "0;4;10;0;18;0;5;6;11;0;16;0". Здесь в дополнение к предыдущему примеру задан режим:

5;6 — с субботы по воскресенье;

11;0 — с 11 часов 0 минут;

16;0 — до 16 часов 0 минут.

Круглосуточный режим работы задается строкой "0;6;00;00;00;00".

Не более 255 символов.

Да
PhonePhone

Структура, задающая номер телефона.

Да
Streetstring

Улица. Не более 55 символов.

Нет
Housestring

Номер дома. Не более 30 символов.

Нет
Buildingstring

Номер строения или корпуса. Не более 10 символов.

Нет
Apartmentstring

Номер квартиры или офиса. Не более 100 символов.

Нет
InstantMessengerInstantMessenger

Структура, задающая контакт для обмена мгновенными сообщениями.

Нет
ExtraMessagestring

Дополнительная информация о рекламируемом товаре или услуге. Не более 200 символов.

Нет
ContactEmailstring

Адрес электронной почты. Не более 255 символов.

Нет
Ogrnstring

Код ОГРН для юридических лиц. Не более 255 символов.

Нет
MetroStationIdlong

Идентификатор станции метрополитена.

Справочник станций можно получить с помощью метода Dictionaries.get.

Нет
PointOnMapMapPoint

Структура, описывающая положение метки на карте. Если не задана, метка ставится по указанному адресу клиента.

Нет
ContactPersonstring

Контактное лицо. Не более 155 символов.

Нет
Структура Phone
CountryCodestring

Телефонный код страны. Должен содержать от 1 до 5 символов. Допустимы значения:

  • начинающиеся со знака «+» и состоящие из цифр;
  • значение «8» в сочетании с кодом города «800».

Например, «+7» для России.

Да
CityCodestring

Телефонный код города. От 1 до 5 цифр. Должен быть отличен от 0.

Да
PhoneNumberstring

Телефонный номер для связи. От 5 до 9 цифр, суммарно с кодом страны и города — от 8 до 17 цифр.

Да
Extensionstring

Добавочный телефонный номер для соединения через офисную АТС. От 1 до 6 цифр.

Нет
Структура InstantMessenger
MessengerClientstring

Тип системы мгновенного обмена сообщениями — icq, jabber, skype, mail_agent.

Да
MessengerLoginstring

Логин (идентификатор) в системе мгновенного обмена сообщениями. Не более 255 символов.

Да
Структура MapPoint
Xdecimal

Долгота точки. От -180 до 180.

Да
Ydecimal

Широта точки. От -90 до 90.

Да
X1decimal

Долгота левого нижнего угла области на карте. От -180 до 180.

Да
Y1decimal

Широта левого нижнего угла области на карте. От -90 до 90.

Да
X2decimal

Долгота правого верхнего угла области на карте. От -180 до 180.

Да
Y2decimal

Широта правого верхнего угла области на карте. От -90 до 90.

Да

Ответ

Структура ответа в формате JSON:

{
  "result": { /* result */
    "AddResults": [{  /* ActionResult */
      "Id": (long),
      "Warnings": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
      }, ... ],
      "Errors": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
      }, ... ] 
    }, ... ]
  }
}
ПараметрТипОписание
Структура result (для JSON) / AddResponse (для SOAP)
AddResultsarray of ActionResultРезультаты добавления визиток.
Структура ActionResult
Idlong

Идентификатор созданной виртуальной визитки. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов.

Warningsarray of ExceptionNotification

Предупреждения, возникшие при выполнении операции.

Errorsarray of ExceptionNotification

Ошибки, возникшие при выполнении операции.

Примеры

Пример запроса
{
  "method" : "add",
  "params" : {
    "VCards" : [
      {
        "Phone" : {
          "CityCode" : "812",
          "Extension" : "89",
          "PhoneNumber" : "123-45-67",
          "CountryCode" : "+7"
        },
        "WorkTime" : "0;3;10;0;18;0;4;6;10;0;11;0",
        "Country" : "Russia",
        "CompanyName" : "Some Company DvKqXuiphd",
        "CampaignId" : 4193065,
        "PointOnMap" : {
          "X" : 39.724068,
          "Y" : 47.222555,
          "X1" : 39.722020,
          "Y1" : 47.221160,
          "X2" : 39.726116,
          "Y2" : 47.223951,

        },
        "City" : "Moscow"
      }
    ]
  }
}
Пример ответа
{
  "result" : {
    "AddResults" : [
      {
        "Id" : 13070322
      }
    ]
  }
}
Пример ответа с предупреждением

Если добавляемая визитка является дубликатом ранее созданной, то новая визитка не создается и выдается предупреждение.

{
  "result" : {
    "AddResults" : [
      {
        "Id" : 13070292,
        "Warnings" : [
          {
            "Code" : 10100,
            "Message" : "The card indicated duplicates a card created earlier"
          }
        ]
      }
    ]
  }
}