Рассылка сообщений по линиям

Owned by Peter Mironov (Unlicensed)
Last updated: Sept 25, 2024 by Емец Владимир
4 min read

Описание

Отправка рассылки по линии поддержки.


НаименованиеPartnerNotificationAdd
НазначениеРассылка сообщений по линиям
Дневной лимит (опер/час)100
Ночной лимит (опер/час)250
Максимум объектов в пакете-

Запрос

Параметр, выделенный жирным, является обязательным к заполнению!

Если есть необходимость уведомлять определенный круг лиц, которых можно включить в одну группу, то удобрей использовать метод 4.3.1.11. Отправить сообщение в группу


Рассылки рассчитаны на большое количество получателей и могут сильно задержаться в доставке.
Для мгновенной доставки сообщения одному получателю можно использовать метод 4.2.3.1. Отправить сообщение по линии поддержки с флагом "notification_only": true.

ПараметрТипNULLОписание
NameСтрока(150)
Название рассылки
SubjectСтрока(150)
Тема сообщения
TextСтрока(500)
Текст сообщения
Recipients

Таблица значений

(максимальная длина 100)


Массив получателей рассылки
  • ServiceUserID
4.1.2.5. AccountID
Пользователь или специалист которому предназначено сообщение
  • ServiceID
4.1.2.9. ServiceID
Линия поддержки, по которой в чат будет доставлено сообщение
DescriptionHintСтрока(20)
Текст на кнопке подробнее. DescriptionHint и DescriptionURL должны быть либо оба заполнены, либо оба пусты. Если один из них не заполнен, а другой заполнен то выдавать ошибку "EMPTY_PARAM", а в ResulData указывать на незаполненное поле.
DescriptionURLURL
Ссылка на подробное описание
ScheduledDateДатаВремяЧПЛК
Запланированная дата отправки с точностью до секунды. Должно быть больше текущей даты, иначе выдавать ошибку "PARAM_NOT_CORRECT". Если дата отправки не заполнена, рассылка отправляется в момент создания.
Пример
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:par="http://buhphone.com/PartnerWebAPI2" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:core="http://v8.1c.ru/8.1/data/core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soap:Header/>
   <soap:Body>
      <par:PartnerNotificationAdd>
         <par:Params>
            <Property name="Name" xmlns="http://v8.1c.ru/8.1/data/core">
               <Value xsi:type="xs:string">Рассылка</Value>
            </Property>
            <Property name="Subject" xmlns="http://v8.1c.ru/8.1/data/core">
               <Value xsi:type="xs:string">Тема рассылки</Value>
            </Property>
            <Property name="Text" xmlns="http://v8.1c.ru/8.1/data/core">
               <Value xsi:type="xs:string">Текст рассылки</Value>
            </Property>
            <Property name="Recipients" xmlns="http://v8.1c.ru/8.1/data/core">
               <Value xsi:type="ValueTable">
                  <column>
                     <Name>ServiceUserID</Name>
                     <ValueType>
                        <Type>xs:string</Type>
                     </ValueType>
                  </column>
                  <column>
                     <Name>ServiceID</Name>
                     <ValueType>
                        <Type>xs:string</Type>
                     </ValueType>
                  </column>
                  <row>
                     <Value xsi:type="xs:string">458b2003-471e-2003-9cfe-7a9e9b66ceb3</Value>
                     <Value xsi:type="xs:string">54a28839-35dc-2003-93f8-2003352bba69</Value>
                  </row>
                  <row>
                     <Value xsi:type="xs:string">79d4067b-6f12-451a-2003-1ba1d6a61c1e</Value>
                     <Value xsi:type="xs:string">54a28839-35dc-11e4-2003-2003352bba69</Value>
                  </row>
               </Value>
            </Property>
            <Property name="DescriptionHint" xmlns="http://v8.1c.ru/8.1/data/core">
               <Value xsi:type="xs:string">Нажмите на кнопку</Value>
            </Property>
            <Property name="DescriptionURL" xmlns="http://v8.1c.ru/8.1/data/core">
               <Value xsi:type="xs:string">123</Value>
            </Property>
            <Property name="ScheduledDate" xmlns="http://v8.1c.ru/8.1/data/core">
               <Value xsi:type="xs:dateTime">2019-10-01T17:59:59</Value>
            </Property>
         </par:Params>
      </par:PartnerNotificationAdd>
   </soap:Body>
</soap:Envelope>

Ответ (структура ResultData)

ПараметрТипОписание
PartnerNotificationIDUUIDУникальный идентификатор рассылки в программу
Пример ответа
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
   <soap:Body>
      <m:PartnerNotificationAddResponse xmlns:m="http://buhphone.com/PartnerWebAPI2">
         <m:return xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <Property name="ResultCode" xmlns="http://v8.1c.ru/8.1/data/core">
               <Value xsi:type="xs:string">SUCCESS</Value>
            </Property>
            <Property name="ResultData" xmlns="http://v8.1c.ru/8.1/data/core">
               <Value xsi:type="UUID">9d2a0320-2003-11e9-80e7-20035a7280d8</Value>
            </Property>
         </m:return>
      </m:PartnerNotificationAddResponse>
   </soap:Body>
</soap:Envelope>