Аккаунт

Метод API

Через API вы можете получить необходимую информацию по аккаунту: название, оплаченный период, пользователи аккаунта и их права, справочники дополнительных полей контактов и сделок, справочник статусов сделок, справочник типов событий, справочник типов задач и другие параметры аккаунта.

URL метода
GET /api/v2/account

Параметры

Параметр Описание
with Если в параметре with указать значения (список см. здесь), в ответ придёт информация из аккаунта по соответствующему значению.

Значения для GET параметра

Возможные значения GET параметра with. Указывать можно более одного значения, через ",".

Пример: https://example.amocrm.ru/api/v2/account?with=pipelines,groups,note_types,task_types

Значение Описание
custom_fields Вернёт информацию по всем дополнительным полям в аккаунте
users Вернёт информацию по всем пользователям в аккаунте
pipelines Вернёт информацию по всем цифровым воронкам в аккаунте
groups Вернёт информацию по всем группам пользователей в аккаунте
note_types Вернёт информацию по всем типам дополнительных полей в аккаунте
task_types Вернёт информацию по всем типам задач в аккаунте

Параметры ответа

Параметр Тип Описание
id int Уникальный идентификатор аккаунта
name string Название аккаунта
subdomain string Уникальный субдомен данного аккаунта
currency string Валюта аккаунта (используемая при работе с бюджетом сделок). Не связано с биллинговой информацией самого аккаунта.
timezone string Временная зона
timezone_offset string Cмещение временной зоны
language string Язык аккаунта (ru - русский, en - английский)
date_pattern array Формат даты (описание формата см. здесь)
date_pattern/date string Дата, формат зависит от выбранного формата в аккаунте
date_pattern/time string Время, формат зависит от выбранного формата в аккаунте
date_pattern/date_time string Дата и время, формат зависит от выбранного формата в аккаунте
date_pattern/time_full string Время с точностью до секунды, формат зависит от выбранного формата в аккаунте
current_user int id текущего пользователя
users array Список пользователей аккаунта с их правами
users/id int Уникальный идентификатор пользователя
users/name string Имя пользователя
users/login string Логин пользователя
users/language string Настройки языка пользователя
users/group_id int id группы, в которой состоит пользователь
users/is_active bool Активна учётная запись пользователя или нет, если нет, то доступ будет закрыт
users/is_free bool Является ли учётная запись пользователя бесплатной
users/is_admin bool Наличие прав администратора
users/rights array Права пользователя (описание формата см. здесь)
users/rights/mail string Доступ к корпоративной почте
users/rights/incoming_leads string Доступ к "неразобранному"
users/rights/catalogs string Права пользователя на создание/редактирование каталогов и их элементов
users/rights/lead_add string Права пользователя на добавление новых сделок
users/rights/lead_view string Права пользователя на просмотра существующих сделок
users/rights/lead_edit string Права пользователя на редактирование существующих сделок
users/rights/lead_delete string Права пользователя на удаление существующих сделок
users/rights/lead_export string Права пользователя на экспорт сделок
users/rights/contact_add string Права пользователя на добавление новых контактов
users/rights/contact_view string Права пользователя на просмотр существующих контактов
users/rights/contact_edit string Права пользователя на редактирование существующих контактов
users/rights/contact_delete string Права пользователя на удаление существующих контактов
users/rights/contact_export string Права пользователя на экспорт контактов
users/rights/company_add string Права пользователя на добавление новых компаний
users/rights/company_view string Права пользователя на просмотр существующих компаний
users/rights/company_edit string Права пользователя на редактирование существующих компаний
users/rights/company_delete string Права пользователя на удаление существующих компаний
users/rights/company_export string Права пользователя на экспорт существующих компаний
custom_fields array Дополнительные поля для разных сущностей.
custom_fields/contacts array Дополнительные поля контактов
custom_fields/leads array Дополнительные поля сделок
custom_fields/companies array Дополнительные поля компаний
custom_fields/customers array Дополнительные поля покупателей
custom_fields/contacts/id int id дополнительного поля контакта (аналогично для сделок, компаний, покупателей)
custom_fields/contacts/name string Имя дополнительного поля (аналогично для сделок, компаний, покупателей)
custom_fields/contacts/field_type int Тип дополнительного поля (аналогично для сделок, компаний, покупателей)
custom_fields/contacts/sort int Порядковый номер при отображении (аналогично для сделок, компаний, покупателей)
custom_fields/contacts/is_multiple bool Обозначение, отвечающие за то является ли доп. поле списком или нет
custom_fields/contacts/is_system bool Является ли доп. поле системным
custom_fields/contacts/is_editable bool Можно ли редактировать поле
custom_fields/contacts/enums array Значения списка, существует в случае, если значение is_multiple равно истине
custom_fields/contacts/enums/id int id значения списка дополнительного поля
custom_fields/contacts/enums/value string Значение списка дополнительного поля
note_types array Список используемых в системе типов примечаний (подробное описание типов см. здесь)
note_types/id int Уникальный идентификатор примечания
note_types/name string Название примечания
note_types/code string Код примечания
note_types/editable bool Существует ли возможность редактирования примечания
task_types array Типы задач доступных для данного аккаунта
task_types/id int Уникальный идентификатор задачи
task_types/name string Название задачи
pipelines array Цифровые воронки имеющиеся на аккаунте
pipelines/id int Уникальный идентификатор воронки
pipelines/name string Название воронки
pipelines/sort int Порядковый номер воронки при отображении
pipelines/is_main bool Является ли воронка "главной"
pipelines/statuses array Этапы цифровой воронки
pipelines/statuses/id int Уникальный идентификатор этапа
pipelines/statuses/name string Название этапа
pipelines/statuses/sort int Порядковый номер этапа при отображении
pipelines/statuses/color string Цвет этапа (подробнее см. здесь)
pipelines/statuses/editable bool Есть ли возможность изменить или удалить этот этап

Формат даты

Код Описание
D Текстовое представление дня недели, 3 символа
d День месяца, 2 цифры с ведущим нулём
M Сокращенное наименование месяца, 3 символа
m Порядковый номер месяца с ведущим нулём
Y Порядковый номер года, 4 цифры
H Часы в 24-часовом формате с ведущим нулём
i Минуты с ведущим нулём
s Секунды с ведущим нулём

Значения прав пользователя

Код Описание
A Разрешено
M Разрешено только, если пользователь является ответственным
D Запрещено
G Разрешено только, если пользователь состоит в соответствующей группе

Response Headeres содержит следующие заголовки:

  • Content-Type:application/hal+json
  • Runtime-Timestamp:1508320306

Пример ответа

  1. {
  2.    id: 13667499,
  3.    name: "your_account_name",
  4.    subdomain: "your_subdomain",
  5.    currency: "RUB",
  6.    timezone: "Europe/Moscow",
  7.    timezone_offset: "+03:00",
  8.    language: "ru",
  9.    date_pattern: {
  10.       date: "d.m.Y",
  11.       time: "H:i",
  12.       date_time: "d.m.Y H:i",
  13.       time_full: "H:i:s"
  14.    },
  15.    current_user: 504141,
  16.    _embedded: {
  17.       users: {
  18.          504141: {
  19.             id: 504141,
  20.             name: "Владимир",
  21.             last_name: "",
  22.             login: "example@example.com",
  23.             language: "ru",
  24.             group_id: 0,
  25.             is_active: true,
  26.             is_free: false,
  27.             is_admin: true,
  28.                rights: {
  29.                   mail: "A",
  30.                   incoming_leads: "A",
  31.                   catalogs: "A",
  32.                   lead_add: "A",
  33.                   lead_view: "A",
  34.                   lead_edit: "A",
  35.                   lead_delete: "A",
  36.                   lead_export: "A",
  37.                   contact_add: "A",
  38.                   contact_view: "A",
  39.                   contact_edit: "A",
  40.                   contact_delete: "A",
  41.                   contact_export: "A",
  42.                   company_add: "A",
  43.                   company_view: "A",
  44.                   company_edit: "A",
  45.                   company_delete: "A",
  46.                   company_export: "A"
  47.                }
  48.          }
  49.       },
  50.       custom_fields: {
  51.          contacts: [
  52.             {
  53.                id: 4396817,
  54.                name: "Должность",
  55.                field_type: 1,
  56.                sort: 2,
  57.                is_multiple: false,
  58.                is_system: true,
  59.               is_editable: true
  60.             },
  61.             {
  62.                id: 4396818,
  63.                name: "Телефон",
  64.                field_type: 8,
  65.                sort: 4,
  66.                is_multiple: true,
  67.                is_system: true,
  68.                is_editable: true,
  69.                enums: [
  70.                   {
  71.                      id: 3685087,
  72.                      value: "WORK"
  73.                   },
  74.                   {
  75.                      id: 3685088,
  76.                      value: "WORKDD"
  77.                   },
  78.                   {
  79.                      id: 3685089,
  80.                      value: "MOB"
  81.                   },
  82.                   {
  83.                      id: 3685090,
  84.                      value: "FAX"
  85.                   },
  86.                   {
  87.                      id: 3685091,
  88.                      value: "HOME"
  89.                   },
  90.                   {
  91.                      id: 3685092,
  92.                      value: "OTHER"
  93.                   }
  94.                ]
  95.             },
  96.             {
  97.                id: 4396819,
  98.                name: "Email",
  99.                field_type: 8,
  100.                sort: 6,
  101.                is_multiple: true,
  102.                is_system: true,
  103.                is_editable: true,
  104.                enums: [
  105.                   {
  106.                      id: 3685093,
  107.                      value: "WORK"
  108.                   },
  109.                   {
  110.                      id: 3685094,
  111.                      value: "PRIV"
  112.                   },
  113.                   {
  114.                      id: 3685095,
  115.                      value: "OTHER"
  116.                   }
  117.                ]
  118.             },
  119.             {
  120.                id: 4396821,
  121.                name: "Мгн. сообщения",
  122.                field_type: 8,
  123.                sort: 10,
  124.                is_multiple: true,
  125.                is_system: true,
  126.                is_editable: true,
  127.                   enums: [
  128.                      {
  129.                         id: 3685096,
  130.                         value: "SKYPE"
  131.                      },
  132.                      {
  133.                         id: 3685097,
  134.                         value: "ICQ"
  135.                      },
  136.                      {
  137.                         id: 3685098,
  138.                         value: "JABBER"
  139.                      },
  140.                      {
  141.                         id: 3685099,
  142.                         value: "GTALK"
  143.                      },
  144.                      {
  145.                         id: 3685100,
  146.                         value: "MSN"
  147.                      },
  148.                      {
  149.                         id: 3685101,
  150.                         value: "OTHER"
  151.                      }
  152.                   ]
  153.             }
  154.          ],
  155.          leads: [],
  156.          companies: [
  157.             {
  158.                id: 4396818,
  159.                name: "Телефон",
  160.                field_type: 8,
  161.                sort: 4,
  162.                is_multiple: true,
  163.                is_system: true,
  164.                is_editable: true,
  165.                enums: [
  166.                   {
  167.                      id: 3685087,
  168.                      value: "WORK"
  169.                   },
  170.                   {
  171.                      id: 3685088,
  172.                      value: "WORKDD"
  173.                   },
  174.                   {
  175.                      id: 3685089,
  176.                      value: "MOB"
  177.                   },
  178.                   {
  179.                      id: 3685090,
  180.                      value: "FAX"
  181.                   },
  182.                   {
  183.                      id: 3685091,
  184.                      value: "HOME"
  185.                   },
  186.                   {
  187.                      id: 3685092,
  188.                      value: "OTHER"
  189.                   }
  190.                ]
  191.             },
  192.             {
  193.                id: 4396819,
  194.                name: "Email",
  195.                field_type: 8,
  196.                sort: 6,
  197.                is_multiple: true,
  198.                is_system: true,
  199.                is_editable: true,
  200.                enums: [
  201.                   {
  202.                      id: 3685093,
  203.                      value: "WORK"
  204.                   },
  205.                   {
  206.                      id: 3685094,
  207.                      value: "PRIV"
  208.                   },
  209.                   {
  210.                      id: 3685095,
  211.                      value: "OTHER"
  212.                   }
  213.                ]
  214.             },
  215.             {
  216.                id: 4396820,
  217.                name: "Web",
  218.                field_type: 7,
  219.                sort: 8,
  220.                is_multiple: false,
  221.                is_system: true,
  222.                is_editable: true
  223.             },
  224.             {
  225.                id: 4396822,
  226.                name: "Адрес",
  227.                field_type: 9,
  228.                sort: 12,
  229.                is_multiple: false,
  230.                is_system: true,
  231.                is_editable: true
  232.             }
  233.          ],
  234.          customers: []
  235.       },
  236.       note_types: [
  237.          {
  238.             id: 1,
  239.             name: "",
  240.             code: "DEAL_CREATED",
  241.             editable: "N"
  242.          },
  243.          {
  244.             id: 2,
  245.             name: "",
  246.             code: "CONTACT_CREATED",
  247.             editable: "N"
  248.          },
  249.          {
  250.             id: 3,
  251.             name: "",
  252.             code: "DEAL_STATUS_CHANGED",
  253.             editable: "N"
  254.          },
  255.          {
  256.             id: 4,
  257.             name: "",
  258.             code: "COMMON",
  259.             editable: "Y"
  260.          },
  261.          {
  262.             id: 5,
  263.             name: "",
  264.             code: "ATTACHEMENT",
  265.             editable: "N"
  266.          },
  267.          {
  268.             id: 6,
  269.             name: "",
  270.             code: "CALL",
  271.             editable: "N"
  272.          },
  273.          {
  274.             id: 7,
  275.             name: "",
  276.             code: "MAIL_MESSAGE",
  277.             editable: "N"
  278.          },
  279.          {
  280.             id: 8,
  281.             name: "",
  282.             code: "MAIL_MESSAGE_ATTACHMENT",
  283.             editable: "N"
  284.          },
  285.          {
  286.             id: 9,
  287.             name: "",
  288.             code: "EXTERNAL_ATTACH",
  289.             editable: "N"
  290.          },
  291.          {
  292.             id: 10,
  293.             name: "",
  294.             code: "CALL_IN",
  295.             editable: "N"
  296.          },
  297.          {
  298.             id: 11,
  299.             name: "",
  300.             code: "CALL_OUT",
  301.             editable: "N"
  302.          },
  303.          {
  304.             id: 12,
  305.             name: "",
  306.             code: "COMPANY_CREATED",
  307.             editable: "N"
  308.          },
  309.          {
  310.             id: 13,
  311.             name: "",
  312.             code: "TASK_RESULT",
  313.             editable: "N"
  314.          },
  315.          {
  316.             id: 17,
  317.             name: "",
  318.             code: "CHAT",
  319.             editable: "N"
  320.          },
  321.          {
  322.             id: 99,
  323.             name: "",
  324.             code: "MAX_SYSTEM",
  325.             editable: "N"
  326.          },
  327.          {
  328.             id: 101,
  329.             name: "Ссылка",
  330.             code: "DROPBOX",
  331.             editable: "N"
  332.          },
  333.          {
  334.             id: 102,
  335.             name: "Входящее",
  336.             code: "SMS_IN",
  337.             editable: "N"
  338.          },
  339.          {
  340.             id: 103,
  341.             name: "Исходящее",
  342.             code: "SMS_OUT",
  343.             editable: "N"
  344.          }
  345.       ],
  346.      groups: [],
  347.      task_types: [
  348.          {
  349.             id: 1,
  350.             name: "Связаться с клиентом"
  351.          },
  352.          {
  353.             id: 1,
  354.             name: "Звонок"
  355.          },
  356.          {
  357.             id: 2,
  358.             name: "Встреча"
  359.          },
  360.          {
  361.             id: 3,
  362.             name: "Письмо"
  363.          }
  364.       ],
  365.       pipelines: {
  366.          10104: {
  367.             id: 10104,
  368.             name: "Воронка",
  369.             sort: 1,
  370.             is_main: true,
  371.             statuses: {
  372.                142: {
  373.                   id: 142,
  374.                   name: "Успешно реализовано",
  375.                   color: "#CCFF66",
  376.                   sort: 10000,
  377.                   editable: "N"
  378.                },
  379.                143: {
  380.                   id: 143,
  381.                   name: "Закрыто и не реализовано",
  382.                   color: "#D5D8DB",
  383.                   sort: 11000,
  384.                   editable: "N"
  385.                },
  386.                13667501: {
  387.                   id: 13667501,
  388.                   name: "Первичный контакт",
  389.                   sort: 10,
  390.                   color: "#99ccff",
  391.                   editable: "Y"
  392.                },
  393.                13667502: {
  394.                   id: 13667502,
  395.                   name: "Переговоры",
  396.                   sort: 20,
  397.                   color: "#ffff99",
  398.                   editable: "Y"
  399.                },
  400.                13667503: {
  401.                   id: 13667503,
  402.                   name: "Принимают решение",
  403.                   sort: 30,
  404.                   color: "#ffcc66",
  405.                   editable: "Y"
  406.                },
  407.                13667504: {
  408.                   id: 13667504,
  409.                   name: "Согласование договора",
  410.                   sort: 40,
  411.                   color: "#ffcccc",
  412.                   editable: "Y"
  413.                }
  414.             }
  415.          }
  416.       }
  417.    }
  418. }

Пример запроса

  1. /* Для начала нам необходимо инициализировать данные, необходимые для составления запроса. */
  2. $subdomain='test'; #Наш аккаунт - поддомен
  3. #Формируем ссылку для запроса
  4. $link='https://'.$subdomain.'.amocrm.ru/api/v2/account';
  5. /* Нам необходимо инициировать запрос к серверу. Воспользуемся библиотекой cURL (поставляется в составе PHP). Вы также
  6. можете
  7. использовать и кроссплатформенную программу cURL, если вы не программируете на PHP. */
  8. $curl=curl_init(); #Сохраняем дескриптор сеанса cURL
  9. #Устанавливаем необходимые опции для сеанса cURL
  10. curl_setopt($curl,CURLOPT_RETURNTRANSFER,true);
  11. curl_setopt($curl,CURLOPT_USERAGENT,'amoCRM-API-client/1.0');
  12. curl_setopt($curl,CURLOPT_URL,$link);
  13. curl_setopt($curl,CURLOPT_HEADER,false);
  14. curl_setopt($curl,CURLOPT_COOKIEFILE,dirname(__FILE__).'/cookie.txt'); #PHP>5.3.6 dirname(__FILE__) -> __DIR__
  15. curl_setopt($curl,CURLOPT_COOKIEJAR,dirname(__FILE__).'/cookie.txt'); #PHP>5.3.6 dirname(__FILE__) -> __DIR__
  16. curl_setopt($curl,CURLOPT_SSL_VERIFYPEER,0);
  17. curl_setopt($curl,CURLOPT_SSL_VERIFYHOST,0);
  18. $out=curl_exec($curl); #Инициируем запрос к API и сохраняем ответ в переменную
  19. $code=curl_getinfo($curl,CURLINFO_HTTP_CODE);
  20. curl_close($curl);
  21. /* Теперь мы можем обработать ответ, полученный от сервера. Это пример. Вы можете обработать данные своим способом. */
  22. $code=(int)$code;
  23. $errors=array(
  24.   301=>'Moved permanently',
  25.   400=>'Bad request',
  26.   401=>'Unauthorized',
  27.   403=>'Forbidden',
  28.   404=>'Not found',
  29.   500=>'Internal server error',
  30.   502=>'Bad gateway',
  31.   503=>'Service unavailable'
  32. );
  33. try
  34. {
  35.   #Если код ответа не равен 200 или 204 - возвращаем сообщение об ошибке
  36.  if($code!=200 && $code!=204) {
  37.     throw new Exception(isset($errors[$code]) ? $errors[$code] : 'Undescribed error',$code);
  38.   }
  39. }
  40. catch(Exception $E)
  41. {
  42.   die('Ошибка: '.$E->getMessage().PHP_EOL.'Код ошибки: '.$E->getCode());
  43. }
  44. /*
  45.   Данные получаем в формате JSON, поэтому, для получения читаемых данных,
  46.   нам придётся перевести ответ в формат, понятный PHP
  47.  */
  48. $Response=json_decode($out,true);
  49. $Response=$Response[0];

Смотрите также

Коды ошибок API