Към съдържанието

R7K12 — CRM API: пълен справочник на методите

Базов URL адрес на всички методи: https://api.r7k12.com/{TOKEN}/<метод> (TOKEN — API ключът на акаунта).


addLeads (POST)

Метод addLeads

Зареждане на информация за нови сделки. В отговор се връща масив с идентификаторите на запазените сделки и/или масив с идентификаторите на сделките, които не са заредени, с описание на причината. Метод: POST Формат: JSON Линк: https://api.r7k12.com/{{TOKEN}}/addLeads Параметри: Таблица 1 Content-type: application/json Таблица 1

Име Стойност Задължителен Описание
id string Да Уникален идентификатор на сделката в CRM системата
name string Не Име на сделката в CRM системата (не повече от 500 символа).
dateCreate unix time Да Дата на създаване на сделката във формат UNIX
status string Да Идентификатор на статуса на сделката в CRM системата. За коректна обработка на сделките е необходимо да заредите статусите чрез метода setStatuses
dateChangeStatus string Не Дата на промяна на статуса във формат Y-m-d
type string Не Тип на запитването (Form/Ringostat/Tilda и т.н. )
r7k12id string Не Уникален идентификатор на посещението (или източник на посещението) в R7K12
price float Не Сума на сделката
cost float Не Себестойност на сделката
clientId string Не Идентификатор на клиента в CRM
manager string Не Идентификатор на мениджъра, отговорен за сделката
shop string Не Магазин, към който се отнася сделката
appealUrl string Не Пълен URL адрес на страницата, от която е направена поръчката. Пример: https://magazine.com/page1/product5/?c=1#block=1
appeals integer Не Брой запитвания по сделката
appealId string Не Идентификатор на запитването, получен чрез метода getAppeals
number integer Не Пореден номер на сделката при контакта
products array[object] Не Масив от продукти, свързани със сделката (описание в Таблица 2).
payment array[object] Не Плащания по сделката (описание в Таблица 3)
fields object Не Допълнителни полета на сделката

Таблица 2

Име Стойност Задължителен Описание
id string Да Уникален идентификатор на продукта
name string Да Име на продукта
price float Да Цена за единица продукт
quantity integer Да Количество

Таблица 3

Име Стойност Задължителен Описание
id string Да Уникален идентификатор на плащането
sum float Да Сума на плащането
status integer Да Статус на плащането (1 - плащането е извършено, -1 - плащането е отменено)
date string Да Дата на извършване на плащането. Формат ГГГГ-ММ-ДД

Пример за тяло на заявката:

[
 {
   "id":"1",
   "name":"Сделка №1",
   "dateCreate": 1508746231,
   "status":"57667454",
   "dateChangeStatus":"2017-10-21",
   "type":"Form",
   "r7k12id": "14154465",
   "price":80.6,
   "cost":70,
   "clientId":"876",
   "manager": 5,
   "products": [
     {
       "id": "1",
       "name": "Продукт 1",
       "price": 0,
       "quantity": 1
     },
     {
       "id": "2",
       "name": "Продукт 2",
       "price": 124.6,
       "quantity": 2
     }
   ],
   "payment": [
     {
       "id": "6458erg",
       "sum": 50,
       "status": 1,
       "date": "2018-04-16"
     },
     {
       "id": "jf94ksm",
       "sum": 100,
       "status": 1,
       "date": "2018-04-20"
     }
   ],
   "fields": {
     "1": "fields 1",
     "45": "fields 3"
   }
 },
 {
   "id":"2",
   "name":"Сделка №2",
   "dateCreate": 1508746531,
   "status":"7454",
   "r7k12id": "site_offline"
 },
 {
   "id":"3",
   "name":"Сделка №3",
   "dateCreate": 1509746531,
   "status":"744"
 }
]

Пример за отговор:

{
 "upload" : [1,2,3],
 "notUpload" : [
   {
     "id" : 4,
     "message" : "Не указан параметр 'dateСreate'"
   },
   {
     "id" : 5,
     "message" : "Сделка с указанным идентификатором уже существует"
   },
   {
     "id" : 6,
     "message" : "Не удалось загрузить сделку. Указана некорректная дата создания сделки"
   }
 ]
}

Пример за скрипт (PHP):

define('TOKEN','XXXXXXXXX');
@file_get_contents(
   'https://api.r7k12.com/'.TOKEN.'/addLeads',
   0,
   stream_context_create(
       [
           'http' => [
               'method' => "POST",
               'header' => "Content-Type: application/json\r\n",
               'content' => json_encode(
                   [
                       [
                           'id' => '1',
                           'name' => 'Сделка №1',
                           'dateCreate' => 1508746231,
                           'status' => '57667454',
                           'type' => 'Form',
                           'r7k12id' => '14154465',
                           'price' => 80.6,
                           'cost' => 70,
                           'clientId' => '876',
                           'manager' => '5',
                           'shop' =>  'магазин',
                           'products' => [
                               [
                                   'id' => '1',
                                   'name' => 'Продукт 1',
                                   'price' => 0,
                                   'quantity' => 1
                               ],
                               [
                                   'id' => '2',
                                   'name' => 'Продукт 2',
                                   'price' => 124.6,
                                   'quantity' => 2
                               ]
                           ],
                           'fields' => [
                               '1' => 'fields 1',
                               '45' => 'fields 3'
                           ]
                       ],
                       [
                           'id' => '2',
                           'name' => 'Сделка №2',
                           'dateCreate' => 1508746531,
                           'status' => '7454',
                           'r7k12id' => 'site_offline',
                       ],
                       [
                           'id' => '3',
                           'name' => 'Сделка №3',
                           'dateCreate' => 1509746531,
                           'status' => '744',
                       ]
                   ]
               )
           ]
       ]
   )
);

getLeads (GET)

Метод getLeads

getLeads

Методът позволява да получите списък със сделки. Вкл. и такива, които са създадени чрез услугата R7K12. Методът връща не повече от 10000 записа на едно извикване, като към отговора на всяка заявка се добавя параметърът „totalResult“ - с общия брой резултати. Метод: GET Линк: https://api.r7k12.com/{{TOKEN}}/getLeads Параметри: Таблица 1 Таблица 1

Параметър Тип Задължителен Описание
id string Не Уникален идентификатор на сделката в CRM. При използване на този параметър в отговора ще бъде сделката с посочения идентификатор (ако такава съществува).
lastModified string Не Дата на последна промяна на сделката. Формат: - ГГГГ-ММ-ДД ЧЧ:ММ:СС - ГГГГ-ММ-ДД. Ако този параметър е посочен, в отговора ще бъдат изведени само сделките, които са били променени/създадени след посочената дата.
fields array [string] Не Списък с полетата, които трябва да бъдат изведени в отговора. Ако параметърът не е зададен, се извеждат само идентификаторите. Налични полета: - id - идентификатор на сделката - r7k12id - идентификатор на „посещението“ - name - име на сделката - status - статус на сделката - type - тип на запитването - dateCreate - дата на създаване (UNIX) - lastModified - дата на промяна - price - сума на сделката - cost - себестойност на сделката - clientId - идентификатор на клиента в CRM - manager - идентификатор на мениджъра, отговорен за сделката - products - масив от продукти - fields - доп. полета на сделката
limit integer Не Брой записи, извеждани в резултата (по подразбиране „10000“)
page integer Не Номер на извежданата страница (по подразбиране „1“)

Пример за заявка:

define('TOKEN','XXXXXXXXX');
$data = @file_get_contents(
   'https://api.r7k12.com/'.TOKEN.'/getLeads?'.
   http_build_query(
       [
           'lastModified' => '2017-11-11',
           'fields' => [
               'id',
               'status',
               'price',
               'cost',
               'fields'
           ],
    'limit'=> 1
       ]
   )
);

Отговор:

{
 "page" : 1,
 "totalResult": 156,
 "data": [
   {
     "id" : "1",
     "status" : "587",
     "price" : 0,
     "cost" : 0,
     "fields" : {
       "source1" : "yandex",
       "source2" : "organic",
       "source3" : "(not set)"
     }
   }
 ]
}

updateLeads (POST)

Метод updateLeads

Обновяване на информацията за съществуващи сделки. Позволява да се обнови всеки параметър на сделката (с изключение на идентификатора). В отговор се връща масив с идентификаторите на обновените сделки и/или масив с идентификаторите на сделките, които не са обновени, с описание на причината. Метод: POST Формат: JSON Линк: https://api.r7k12.com/{{TOKEN}}/updateLeads Параметри: Таблица 1 Content-type: application/json Таблица 1

Име Стойност Задължителен Описание
id string Да Уникален идентификатор на обновяваната сделка в CRM системата
name string Не Име на сделката в CRM системата (не повече от 500 символа).
status string Не Идентификатор на статуса на сделката в CRM системата.
dateChangeStatus string Не Дата на промяна на статуса във формат Y-m-d
type string Не Тип на запитването (Form/Ringostat/Tilda и т.н. )
type string Не Тип на запитването (Form/Ringostat/Tilda и т.н. )
price float Не Сума на сделката
cost float Не Себестойност на сделката
clientId string Не Идентификатор на клиента в CRM
manager string Не Идентификатор на мениджъра, отговорен за сделката
shop string Не Магазин, към който се отнася сделката
appealUrl string Не Пълен URL адрес на страницата, от която е направена поръчката. Пример: https://magazine.com/page1/product5/?c=1#block=1
appeals integer Не Брой запитвания по сделката
appealId string Не Идентификатор на запитването, получен чрез метода getAppeals
number integer Не Пореден номер на сделката при контакта
products array[object] Не Масив от продукти, свързани със сделката (описание в Таблица 2).
payment array[object] Не Плащания по сделката (описание в Таблица 3)
fields object Не Допълнителни полета на сделката. Забележка: при изпращане на параметъра „fields“ той се презаписва изцяло

Таблица 2

Име Стойност Задължителен Описание
id string Да Уникален идентификатор на продукта
name string Да Име на продукта
price float Да Цена за единица продукт
quantity integer Да Количество

Таблица 3

Име Стойност Задължителен Описание
id string Да Уникален идентификатор на плащането
sum float Да Сума на плащането
status integer Да Статус на плащането (1 - плащането е извършено, -1 - плащането е отменено)
date string Да Дата на извършване на плащането. Формат ГГГГ-ММ-ДД

Пример за тяло на заявката:

[
 {
   "id":"1",
   "name":"Сделка закрыта"//Обновить название сделки
   "status":"100"//Обновить статус сделки
 }, 
 {
   "id":"2",
   "price":7454//Обновить сумму сделки
 }, 
 {
   "id":"3",
   "products": [//Обновить список продуктов
     {
       "id": "1",
       "name": "Продукт 1",
       "price": 0,
       "quantity": 1
     },
     {
       "id": "2",
       "name": "Продукт 2",
       "price": 124.6,
       "quantity": 2
     }
   ]
 }
]

Пример за отговор:

{
 "update" : [1,2,3],
 "notUpdate" : [
   {
     "id" : NULL,
     "message" : "Не указан идентификатор сделки"
   },
   {
     "id" : 5,
     "message" : "Сделка с указанным идентификатором не существует"
   }
 ]
}

Пример за скрипт (PHP):

define('TOKEN','XXXXXXXXX');
@file_get_contents(
   'https://api.r7k12.com/'.TOKEN.'/updateLeads',
   0,
   stream_context_create(
       [
           'http' => [
               'method' => "POST",
               'header' => "Content-Type: application/json\r\n",
               'content' => json_encode(
                   [
                       [
                           'id' => '1',
                           'name' => 'Сделка закрыта',
                           'status' => '100'
                       ],
                       [
                           'id' => '2',
                           'price' => 7454
                       ],
                       [
                           'id' => '3',
                           'products' => [
                               [
                                   'id' => '1',
                                   'name' => 'Продукт 1',
                                   'price' => 0,
                                   'quantity' => 1
                               ],
                               [
                                   'id' => '2',
                                   'name' => 'Продукт 2',
                                   'price' => 124.6,
                                   'quantity' => 2
                               ]
                           ]
                       ]
                   ]
               )
           ]
       ]
   )
);

deleteLeads (POST)

Метод deleteLeads

deleteLeads

Методът позволява да изтриете сделки. Метод: POST Формат: JSON Линк: https://api.r7k12.com/{{TOKEN}}/deleteLeads Параметри: Таблица 1 Content-type: application/json Таблица 1

Име Стойност Задължителен Описание
ids array[string] Да Масив с уникалните идентификатори на сделките, които трябва да бъдат изтрити

Пример за тяло на заявката:

{
 "ids" : [1,2,3]
}

Пример за скрипт (PHP):

define('TOKEN','XXXXXXXXX');
@file_get_contents(
   'https://api.r7k12.com/'.TOKEN.'/deleteLeads',
   0,
   stream_context_create(
       [
           'http' => [
               'method' => "POST",
               'header' => "Content-Type: application/json\r\n",
               'content' => json_encode(
                   [
                       'ids' => [1, 2, 3]
                   ]
               )
           ]
       ]
   )
);

addContacts (POST)

Метод addContacts

addContacts

Зареждане на информация за нови контакти. В отговор се връща масив с идентификаторите на запазените контакти и/или масив с идентификаторите на контактите, които не са заредени, с описание на причината. Метод: POST Формат: JSON Линк: https://api.r7k12.com/{{TOKEN}}/addContacts Параметри: Таблица 1 Content-type: application/json

Параметър Тип Задължителен Описание
id string Да Уникален идентификатор на контакта в CRM.
name string Не Име на контакта
dateCreate double (UNIX) Да Дата на създаване на контакта
phone array [string] Не (ако има e-mail) Масив с телефонните номера на контакта
email array [string] Не (ако има phone) Масив с e-mail адресите на контакта
leads array [string] Не Масив с идентификаторите на сделките, към които се отнася този контакт.

Пример за тяло на заявката:

[
 {
   "name": "Контакт 1",
   "id": "1",
   "dateCreate": 1497800760,
   "phone": [
     "380441234567",
     "380443215476"
   ],
   "email": [
     "[email protected]",
     "[email protected]"
   ],
   "leads": [
     "150",
     "6583"
   ]
 },
 {
   "name": "Контакт 2",
   "id": "2",
   "dateCreate": 1497800760,
   "phone": [
     "380441234568"
   ]
 },
 {
   "name": "Контакт 3",
   "id": "3",
   "dateCreate": 1497800760,
   "email": [
     "[email protected]"
   ],
   "leads": [
     "67889"
   ]
 }
]

Пример за отговор:

{
 "upload" : [1,2,3],
 "notUpload" : [
   {
     "id" : 4,
     "message" : "Не указан параметр 'dateСreate'"
   },
   {
     "id" : 5,
     "message" : "Контакт с указанным идентификатором уже существует"
   }
 ]
}

Пример за скрипт (PHP):

define('TOKEN','XXXXXXXXX');
@file_get_contents(
   'https://api.r7k12.com/'.TOKEN.'/addContacts',
   0,
   stream_context_create(
       [
           'http' => [
               'method' => "POST",
               'header' => "Content-Type: application/json\r\n",
               'content' => json_encode(
                   [
   [
       'name' => 'Контакт 1',
       'id' => '1',
       'dateCreate' => 1497800760,
       'phone' => [
           '380441234567',
           '380443215476'
       ],
       'email' => [
           '[email protected]',
           '[email protected]'
       ],
       'leads' => [
           '150',
           '6583'
       ]
   ],
   [
       'name' => 'Контакт 2',
       'id' => '2',
       'dateCreate' => 1497800760,
       'phone' => [
           '380441234568'
       ]
   ],
   [
       'name' => 'Контакт 3',
       'id' => '3',
       'dateCreate' => 1497800760,
       'email' => [
           '[email protected]'
       ],
       'leads' => [
           '67889'
       ]
   ]
]
               )
           ]
       ]
   )
);

getContacts (GET)

Метод getContacts

getContacts

Методът позволява да получите списък с контакти. Вкл. и такива, които са създадени чрез услугата R7K12. Методът връща не повече от 10000 записа на едно извикване, като към отговора на всяка заявка се добавя параметърът „totalResult“ - с общия брой резултати. Метод: GET Линк: https://api.r7k12.com/{{TOKEN}}/getContacts Параметри: Таблица 1 Таблица 1

Параметър Тип Задължителен Описание
id string Не Уникален идентификатор на контакта в CRM. При използване на този параметър в отговора ще бъде контактът с посочения идентификатор (ако такъв съществува).
lastModified string Не Дата на последна промяна на контакта. Формат: - ГГГГ-ММ-ДД ЧЧ:ММ:СС - ГГГГ-ММ-ДД. Ако този параметър е посочен, в отговора ще бъдат изведени само контактите, които са били променени/създадени след посочената дата.
fields array [string] Не Списък с полетата, които трябва да бъдат изведени в отговора. Ако параметърът не е зададен, се извеждат само идентификаторите. Налични полета: - id - идентификатор на контакта - name - име на контакта - phone - масив с телефонни номера - email - масив с email адреси - leads - масив с идентификатори на сделки - dateCreate - дата на създаване (UNIX) - lastModified - дата на промяна (UNIX)
limit integer Не Брой записи, извеждани в резултата (по подразбиране „10000“)
page integer Не Номер на извежданата страница (по подразбиране „1“)

Пример за заявка:

define('TOKEN','XXXXXXXXX');
$data = @file_get_contents(
   'https://api.r7k12.com/'.TOKEN.'/getContacts?'.
   http_build_query(
       [
           'fields' => [
               'id',
               'phone',
               'leads'
           ],
           'limit' => 1
       ]
   )
);

Отговор:

{
 "page" : 1,
 "totalResult": 100,
 "data": [
   {
     "id" : "43",
     "phone" : [
       "380441234567",
       "380503215476"
     ],
     "leads" : [
       "1"
     ]
   }
 ]
}

updateContacts (POST)

Метод updateContacts

updateContacts

Обновяване на информацията за съществуващи контакти. Позволява да се обнови всеки параметър на контакта (с изключение на идентификатора). В отговор се връща масив с идентификаторите на обновените контакти и/или масив с идентификаторите на контактите, които не са обновени, с описание на причината. Метод: POST Формат: JSON Линк: https://api.r7k12.com/{{TOKEN}}/updateContacts Параметри: Таблица 1 Content-type: application/json Таблица 1

Параметър Тип Задължителен Описание
id string Да Уникален идентификатор на контакта в CRM.
name string Не Име на контакта
phone array [string] Не Масив с нови телефонни номера на контакта, които трябва да бъдат добавени
email array [string] Не Масив с e-mail адреси на контакта, които трябва да бъдат добавени
leads array [string] Не Масив с идентификатори на сделките, към които се отнася този контакт, които трябва да бъдат добавени

Пример за тяло на заявката:

[
 {
   "name": "Name update",
   "id": "1"
 },
 {
  "id": "2",
   "phone": [
     "380441234560"
   ]
 },
 {
   "id": "3",
   "email": [
     "[email protected]"
   ],
   "leads": [
     "679"
   ]
 }
]

Пример за отговор:

{
 "upload" : [1,2,3],
 "notUpdate" : [,
   {
     "id" : 5,
     "message" : "Контакт с указанным идентификатором не существует"
   }
 ]
}

Пример за скрипт (PHP):

define('TOKEN','XXXXXXXXX');
@file_get_contents(
   'https://api.r7k12.com/'.TOKEN.'/updateContacts',
   0,
   stream_context_create(
       [
           'http' => [
               'method' => "POST",
               'header' => "Content-Type: application/json\r\n",
               'content' => json_encode(
                   [
   [
       'name' => 'Name update',
       'id' => '1'
   ],
   [
       'id' => '2',
       'phone' => [
           '380441234560'
       ]
   ],
   [
       'id' => '3',
       'email' => [
           '[email protected]'
       ],
       'leads' => [
           '679'
       ]
   ]
]
               )
           ]
       ]
   )
);

deleteContacts (POST)

Метод deleteContacts

deleteContacts

Методът позволява да изтриете сделки. Метод: POST Формат: JSON Линк: https://api.r7k12.com/{{TOKEN}}/deleteContacts Параметри: Таблица 1 Content-type: application/json Таблица 1

Име Стойност Задължителен Описание
ids array[string] Да Масив с уникалните идентификатори на контактите, които трябва да бъдат изтрити

Пример за тяло на заявката:

{
"ids" : [1,2,3]
}

Пример за скрипт (PHP):

define('TOKEN','XXXXXXXXX');
@file_get_contents(
   'https://api.r7k12.com/'.TOKEN.'/deleteContacts',
   0,
   stream_context_create(
       [
           'http' => [
               'method' => "POST",
               'header' => "Content-Type: application/json\r\n",
               'content' => json_encode(
                   [
                       'ids' => [1, 2, 3]
                   ]
               )
           ]
       ]
   )
);

setStatuses (POST)

Метод setStatuses

Зареждане на статусите на сделките. Ако бъде предаден статус с ID, който вече е записан в услугата R7K12, статусът ще бъде обновен. Метод: POST Формат: JSON Линк: https://api.r7k12.com/{{TOKEN}}/setStatuses Параметри: Таблица 1 Content-type: application/json Таблица 1

Име Стойност Задължителен Описание
id string Да Уникален идентификатор на статуса в CRM системата
group integer Да Група, към която се отнася статусът. Стойност от 1 до 4. - 1 - Не се отчита - 2 - В обработка - 3 - Успешно реализирано - 4 - Отказ
name string Не Име на статуса в CRM системата (не повече от 500 символа).

Пример за тяло на заявката:

[
 {
   "id":"56385",
   "group":"1",//Не учитывать
   "name":"Новый заказ"
 },
 {
   "id":"57667454",
   "group":"3"//Успешно реализовано
 }
]

Пример за скрипт (PHP):

define('TOKEN','YOURTOKEN');
@file_get_contents(
   'https://api.r7k12.com/'.TOKEN.'/setStatuses',
   0,
   stream_context_create(
       [
           'http' => [
               'method' => "POST",
               'header' => "Content-Type: application/json\r\n",
               'content' => json_encode(
                   [
                       [
                           'id' => '56385',
                           'group' => '1',
                           'name' => 'Новый заказ'
                       ],
                       [
                           'id' => '57667454',
                           'group' => '3'
                       ],
                   ]
               ),
           ],
       ]
   )
);

setManagers (POST)

Метод setManagers

Методът позволява да заредите списъка с мениджъри на CRM системата. Ако бъде предаден мениджър с ID, който вече е записан в услугата R7K12, името на мениджъра ще бъде обновено. Метод: POST Формат: JSON Линк: https://api.r7k12.com/{{TOKEN}}/setManagers Параметри: Таблица 1 Content-type: application/json Таблица 1

Име Стойност Задължителен Описание
id string Да Уникален идентификатор на мениджъра в CRM системата
name string Да Име на мениджъра

Пример за тяло на заявката:

[
 {
   "id":"1",
   "name":"Менеджер №1"
 },
 {
   "id":"2",
   "name":"Менеджер №2"
 }
]

Пример за скрипт (PHP):

define('TOKEN','YOURTOKEN');
@file_get_contents(
   'https://api.r7k12.com/'.TOKEN.'/setManagers',
   0,
   stream_context_create(
       [
           'http' => [
               'method' => "POST",
               'header' => "Content-Type: application/json\r\n",
               'content' => json_encode(
                   [
                       [
                           'id' => '1',
                           'name' => 'Менеджер №1'
                       ],
                       [
                           'id' => '2',
                           'name' => 'Менеджер №2'
                       ],
                   ]
               ),
           ],
       ]
   )
);

getAppeals (GET)

Метод getAppeals

getAppeals

Методът позволява да получите списък със запитванията, които са постъпили в услугата R7K12. Методът връща не повече от 10000 записа на едно извикване, като към отговора на всяка заявка се добавя параметърът „totalResult“ - с общия брой резултати. Метод: GET Линк: https://api.r7k12.com/{{TOKEN}}/getAppeals Параметри: Таблица 1 Таблица 1

Параметър Тип Задължителен Описание
date string Не Дата на постъпване на запитването в системата. Формат: - ГГГГ-ММ-ДД ЧЧ:ММ:СС - ГГГГ-ММ-ДД. Ако този параметър е посочен, в отговора ще бъдат изведени само запитванията, които са били създадени след посочената дата.
phone string Не Телефонен номер, посочен в запитването. Трябва да се състои само от цифри Ако е посочен, ще бъдат изведени само запитванията, в които телефонният номер съвпада със зададения номер.
email string Не Адрес на електронна поща, посочен в запитването. Трябва да бъде валиден адрес на електронна поща. Ако е посочен, ще бъдат изведени само запитванията, в които телефонният номер съвпада със зададения email.
fields array [string] Не Списък с полетата, които трябва да бъдат изведени в отговора. Ако параметърът не е зададен, се извеждат само идентификаторите на сесиите (r7k12id). Налични полета: - id - идентификатор на запитването - r7k12id - идентификатор на сесията - name - име, посочено в запитването - phone - телефонен номер - email - email адрес - comment - коментар - date - дата на създаване (UNIX) - type - тип на запитването - call_duration - продължителност на обаждането - call_record - линк към записа на разговора - call_status - статус на обаждането - price - цена на сделката - href - линк към страницата, от която е направена заявката - raw_data - данните по заявката във вида, в който са пристигнали
limit integer Не Брой записи, извеждани в резултата (по подразбиране „10000“)
page integer Не Номер на извежданата страница (по подразбиране „1“)

Пример за заявка:

define('TOKEN','XXXXXXXXX');

$data = @file_get_contents(

  'https://api.r7k12.com/'.TOKEN.'/getAppeals?'.

  http_build_query(

      [

          'fields' => [

              'r7k12id',

              'name',

              'phone',

              'email'

          ],

          'limit' => 1

      ]

  )

);

Ответ:

{

"page" : 1,

"totalResult": 100,

"data": [

  {

    "r7k12id" : "4239487948343",

    "name" : "Contact’s Name",

    "phone" : "380441234567",

    "email" : "[email protected]"

  }

]

}

updateIdsEssenceCrm (POST)

Метод updateIdsEssenceCrm

updateIdsEssenceCrm

Методът позволява да обновите уникалния идентификатор на обект (контакт/сделка) в CRM. Този метод е подходящ при интеграция „Собствена CRM“ и използване на модула за изпращане на данни, когато е необходимо да замените присвоения от услугата R7K12 идентификатор на обекта в CRM със свой. Метод: POST Формат: JSON Линк: https://api.r7k12.com/{{TOKEN}}/updateIdsEssenceCrm Параметри: Таблица 1 Content-type: application/json Таблица 1

Име Стойност Задължителен Описание
type ENUM (‘lead’, ’contact’) Да Тип на обекта в CRM, чийто идентификатор трябва да бъде променен
oldId string Да Идентификатор на обекта, който е зададен в момента.
newId string Да Идентификатор на обекта, който трябва да бъде зададен.

Пример за тяло на заявката:

[
 {
   "type":"lead",
   "oldId":"jf97gaossz",
   "newId":"301cb030-4126-4065-94d9-8dc2a345573d"
 },
 {
   "type":"lead",
   "oldId":"6y62zhzifs",
   "newId":"2ed7874b-3646-499b-a54e-ccd31a843527"
 },
 {
   "type":"contact",
   "oldId":"3reuqfl2di",
   "newId":"f77b6a3f-aab3-4a80-b752-cdfe15ae31b2"
 }
]

Пример за отговор:

[
 {
   "type":"lead",
   "id":"jf97gaossz",//oldId
   "status":"success"
 },
 {
   "type":"lead",
   "id":"6y62zhzifs",
   "status":"error",
   "error_message":"Новый идентификатор не является уникальным"
 },
 {
   "type":"contact",
   "id":"3reuqfl2di",
   "status":"success"
 }
]

Пример за скрипт (PHP):

define('TOKEN','XXXXXXXXX');
@file_get_contents(
   'https://api.r7k12.com/'.TOKEN.'/updateIdsEssenceCrm',
   0,
   stream_context_create(
       [
           'http' => [
               'method' => "POST",
               'header' => "Content-Type: application/json\r\n",
               'content' => json_encode(
                   [
                       [
                           'type' => 'lead',
                           'oldId' => 'jf97gaossz',
                           'newId' => '301cb030-4126-4065-94d9-8dc2a345573d'
                       ],
                       [
                           'type' => 'lead',
                           'oldId' => '6y62zhzifs',
                           'newId' => '2ed7874b-3646-499b-a54e-ccd31a843527'
                       ],
                       [
                           'type' => 'contact',
                           'oldId' => '3reuqfl2di',
                           'newId' => 'f77b6a3f-aab3-4a80-b752-cdfe15ae31b2'
                       ]
                   ]
               )
           ]
       ]
   )
);

setShippingTrackingId (POST)

Метод setShippingTrackingId

Методът позволява да добавите или обновите номера за проследяване на пощенска пратка в сделката. При посочване на номер на товарителница куриерската служба трябва да бъде свързана в интеграциите на R7K12CRM. Максимален брой входни данни — 100. Метод: POST Линк: https://api.r7k12.com/{{TOKEN}}/R7K12Crm Параметри: Таблица №1 Входни данни:

{

 "method": "setShippingTrackingId",

 "input": [

   {

     "dealId": (string),

     "type": (string),

     "shippingId": (string)

   },

   ...

 ]

}

Таблица №1

Параметър Тип Задължителен Описание
method string Да Извикваният метод. Винаги „setShippingTrackingId“
input array[object] Да Входни параметри на метода
input[index].dealId string Да Идентификатор на сделката
input[index].type string Да Идентификатор на куриерската служба, към която се отнася номерът за проследяване - „novaPoshta“ - Нова Пошта
input[index].shippingId string Да Номер за проследяване на пощенската пратка

Пример за заявка:

define('TOKEN','YOURTOKEN');

function POST ($request) {
   $curl = curl_init();
   curl_setopt($curl, CURLOPT_URL, 'https://api.r7k12.com/'.TOKEN.'/R7K12Crm');
   curl_setopt($curl, CURLOPT_RETURNTRANSFER,true);
   curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($request,JSON_UNESCAPED_UNICODE));
   $out = curl_exec($curl);
   curl_close($curl);
   return json_decode($out,true);
}

$response = POST(
   [
            'method' => 'setShippingTrackingId' ,
            'input' => [
                    [
'dealId' => '5e450c947e7c21254b42a942',
'fields' => 'novaPoshta',
'fields' => '1234567890',
]
]
       ]
);

print_r($response);

Обработка на отговора:

{

 "success": true,

 "warning": [

   {

     "dealId": (string),

     "type": (syting),

     "shippingId": (string),

     "error": (string)

   }

 ]

}

Таблица №2

Параметър Тип Задължителен Описание
success true Не Флаг за успешна обработка на всички заредени данни. Присъства само ако всички данни са обработени успешно
warning array[object] Не Масив с необработените входни данни
warning[index].dealId string Да Идентификатор на сделката
warning[index].type string Да Идентификатор на куриерската служба, към която се отнася номерът за проследяване - „novaPoshta“ - Нова Пошта
warning[index].shippingId string Да Номер за проследяване на пощенската пратка
warning[index].error string Да Причина, поради която данните не са обработени: - Field "dealId": must be string (a-z0-9) - Deal not found - Incorrect field "shippingId" - Incorrect shipping system - The electronic invoice number "XXXXX" is already set on another deal - Shipping system is not enabled

Грешки на API

Формат на отговора:

{

 "error": {

   "code": (int),

   "error": (string),

   "error_detail": (string)

 }

}

Таблица №3

Код Грешка Описание
-1 Заявката не може да бъде изпълнена Възникна вътрешна грешка в API. Свържете се с техническата поддръжка, като посочите requestId
20 Невалиден ключ за достъп
21 Невалиден метод
22 Некоректен формат на данните
23 Не са посочени задължителните параметри
24 Интеграцията с API не е свързана
25 Грешка при запис
26 Максималният брой записи в заявка е 100
27 Интервалът между заявките трябва да бъде не по-малко от 3 секунди
28 Няма достъп до избрания проект
29 Нямате достатъчно права за изпълнение на този метод
210 За изпълнение на избрания метод е необходим потребителски ключ за достъп Необходимо е да получите ключ по схемата OAUTH2
211 Токенът за достъп е блокиран За допълнителна информация се свържете с техническата поддръжка
212 Не е възможно паралелно изпълнение на заявки с еднакви методи Избраният метод на API вече се използва в паралелна заявка с посочения токен
301 Invalid API Method Извикан е некоректен метод на API на R7K12 CRM
302 R7K12 CRM is not connected in the project R7K12 CRM не е свързана в проекта
303 Integration not connected in R7K12 CRM Интеграцията не е свързана в R7K12 CRM
304 Incorrect input data Некоректни входни данни
305 A lot of data Превишен е максималният брой входни данни