Отправка информации про контакт/лид/сделку в Ringostat Smart Phone и книгу контактов

Данный метод позволит передавать информацию от CRM интегрируемых по Webhook для отображения информации о клиенте в книге контактов Ringostat Smart Phone и журнал звонков.

При помощи данного метода можно отправлять:

- Имя

- Номер телефона

- Email

- Ссылку для быстрого перехода в контакт или сделку

Основные параметры запроса:

Адрес API-запроса: https://api.ringostat.net/minicrm/contacts/sync
Метод — POST;

Headers запроса:

Content-Type - application/json
auth-key - это электронный ключ для доступа к вашему проекту в Ringostat
x-project-id - ID вашего проекта

Body запроса:

Название параметра	Тип данных	Обязательный	Описание
projectId	int	да	Id проекта (указан в блоке доступы)
fullName	string	да	Имя контакта
origin	string	да	Название СRM
externalId	string	Да. Может быть = null, если заполнено поле lead_id	id контакта в СRM
leadId	string	Да. Может быть = null, если заполнено поле external_id	id лида в СRM
responsible	string	да	ID ответственного сотрудника в CRM Значение может быть в числовом или буквенном формате. Если нет ответственного - можно отправлять "0" или "Unknown"
staffId	string	Да. Может быть = null	ID сотрудника в Ringostat согласно настройкам интеграции
contactLink	string	Да. Может быть = null	ссылка на контакт
leadLink	string	Да. Может быть = null	ссылка на лид
dealLink	string	Да. Может быть = null	ссылка на сделку
googleClientId	string	Да. Может быть = null	client id из Google Analytics
contactDirections	array of objects	да	массив с номерами и почтами контакта, должен иметь минимум одно направление
type	string	да	тип направления: phone/email
name	string	да	название направления (work, personal, etc.)
value	string	да	номер или емейл
organizations	array of objects	Да. Может быть = null	массив с организациями, к которым принадлежит контакт
projectId	int	Да, если заполняется "organizations"	Id проекта (указан в блоке доступы)
name	string	Да, если заполняется "organizations"	название организации
externalId	string	Да, если заполняется "organizations"	ID организации в СRM
origin	string	Да, если заполняется "organizations"	Название СRM

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

curl -i -X POST \
   -H "auth-key:unique_auth_key_value" \
   -H "x-project-id:project-id" \
   -H "Content-Type:application/json" \
   -d \
'{
  "contacts": [
    {
      "projectId": project-id,
      "fullName": "Client name",
      "origin": "Crm name",
      "externalId": null,
      "leadId": "7895643",
      "responsible": "manager1",
      "staffId": null,
      "contactLink": "https://crmname.com/contact/6835653",
      "leadLink": "https://crmname.com/lead/7895643",
      "dealLink": "https://crmname.com/deal/1835367",
      "googleClientId": null,
      "organizations": [
      {
      "projectId": project-id,
      "name": "Organization name",
      "externalId":"124532",
      "origin": "Crms name"
    }
  ],
  "contactDirections": [
    {
      "name": "Client name",
      "type": "phone",
      "value": "+380111111111"
    },
     {
      "name": "Client name",
      "type": "email",
      "value": "с[email protected]"
    }
  ]
}
]
}' \
 'https://api.ringostat.net/minicrm/contacts/sync'

Отправка информации об организации в Ringostat Smart Phone

Данный метод передает информацию по организации для дополнения контакта в книге контактов Ringostat Smart Phone.

Основные параметры запроса:

Адрес API-запроса: https://api.ringostat.net/minicrm/organizations/sync
Метод — POST;

Headers запроса:

Content-Type - application/json
auth-key - это электронный ключ для доступа к вашему проекту в Ringostat
x-project-id - ID вашего проекта

Body запроса:

Название параметра	Тип данных	Обязательный	Описание
organizations	array of objects	да	массив с организациями, к которым принадлежит контакт
projectId	int	да	Id проекта (указан в блоке доступы)
name	string	да	название организации
externalId	string	да	ID организации в СRM
origin	string	да	Название СRM

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

curl -i -X POST \
   -H "auth-key:unique_auth_key_value" \
   -H "x-project-id:project-id" \
   -H "Content-Type:application/json" \
   -d \
'{
    "organizations": [
        {
            "projectId": 106,
            "name": "organization1",
            "externalId": "1",
            "origin": "Crm"
        },
        {
            "projectId": 106,
            "name": "organization2",
            "externalId": "2",
            "origin": "Crm"
        },
        {
            "projectId": 106,
            "name": "organization3",
            "externalId": "3",
            "origin": "Crm"
        }
    ]
}' \
 'https://api.ringostat.net/minicrm/organizations/sync'

Также описание и примеры можно посмотреть в личном кабинете, в разделе “Настройки” - “Интеграции” - “Ringostat API”, нажав на нужный API метод:

Пример отображения в RSP и журнале звонков

Кнопки сделки, лида и контакта будут активны, со ссылками которые вы указали при api запросе

Также контакт будет доступен в списке контактов RSP

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

Важно! Мы будем отображать данные по клиенту в журнале звонков только по новым звонкам, которые были после запроса.

Другие статьи по теме

API Ringostat. Экспорт данных о сотрудниках проекта