• Post category:Контакты
  • Запись изменена:03.11.2022

GET api/2.0/crm/contact/bycontactinfo

Для этой функции требуется аутентификация. 

Описание

Возвращает список контактов из модуля CRM с контактной информацией, указанной в запросе.

Параметры
Название Описание Тип Пример
infoType

sent in url
Тип контактной информации

необязательно
ASC.CRM.Core.ContactInfoType
data

sent in url
Контактные данные строковый текст
category

sent in url
Категория контакта

необязательно

номер 1234
isPrimary

sent in url
Contact importance: primary or not

Важность контакта: первичная или нет
необязательно
логический правда
Пример
GET api/2.0/crm/contact/bycontactinfo?data=some+text
Host: yourportal.r7-office.ru
Content-Type: application/json
Accept: application/json

Возвращает

Список контактов

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

application/json

{
  "status": 0,
  "response": [
    {
      "firstName": "Tadjeddine",
      "lastName": "Bachir",
      "company": {
        "companyName": "Food and Culture Project",
        "about": "",
        "haveLateTasks": false,
        "displayName": null,
        "isCompany": true,
        "isPrivate": true,
        "isShared": false,
        "shareType": 0,
        "currency": null,
        "canEdit": false,
        "canDelete": false,
        "id": 0
      },
      "title": "Programmer",
      "createBy": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "created": "2022-10-07T10:03:01.5297197Z",
      "about": "",
      "commonData": [
        {
          "id": 0,
          "infoType": 1,
          "category": 0,
          "data": "support@Р7.com",
          "categoryName": "Home",
          "isPrimary": true
        }
      ],
      "customFields": [
        {
          "entityId": 14523423,
          "label": "Birthdate",
          "fieldValue": "2022-10-07T10:03:01.5297197Z",
          "fieldType": 5,
          "position": 10,
          "mask": "",
          "id": 0
        }
      ],
      "haveLateTasks": false,
      "displayName": null,
      "isCompany": false,
      "isPrivate": true,
      "isShared": false,
      "shareType": 0,
      "currency": null,
      "canEdit": true,
      "canDelete": true,
      "id": 0
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <firstName>Tadjeddine</firstName>
    <lastName>Bachir</lastName>
    <company>
      <companyName>Food and Culture Project</companyName>
      <about></about>
      <haveLateTasks>false</haveLateTasks>
      <displayName />
      <isCompany>true</isCompany>
      <isPrivate>true</isPrivate>
      <isShared>false</isShared>
      <shareType>0</shareType>
      <currency />
      <canEdit>false</canEdit>
      <canDelete>false</canDelete>
      <id>0</id>
    </company>
    <title>Programmer</title>
    <createBy>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </createBy>
    <created>2022-10-07T10:03:01.5297197Z</created>
    <about></about>
    <commonData>
      <id>0</id>
      <infoType>1</infoType>
      <category>0</category>
      <data>support@Р7.com</data>
      <categoryName>Home</categoryName>
      <isPrimary>true</isPrimary>
    </commonData>
    <customFields>
      <entityId>14523423</entityId>
      <label>Birthdate</label>
      <fieldValue>2022-10-07T10:03:01.5297197Z</fieldValue>
      <fieldType>5</fieldType>
      <position>10</position>
      <mask></mask>
      <id>0</id>
    </customFields>
    <haveLateTasks>false</haveLateTasks>
    <displayName />
    <isCompany>false</isCompany>
    <isPrivate>true</isPrivate>
    <isShared>false</isShared>
    <shareType>0</shareType>
    <currency />
    <canEdit>true</canEdit>
    <canDelete>true</canDelete>
    <id>0</id>
  </response>
</result>