Перейти до основного контенту
Усі колекціїAPI та WebhooksAPI
API Ringostat. Передача інформації у Ringostat Smart Phone та книгу контактів
API Ringostat. Передача інформації у Ringostat Smart Phone та книгу контактів
Katerina Tverdochleb avatar
Автор: Katerina Tverdochleb
Оновлено протягом останнього тижня

Передача інформації про контакт/лід/угоду у Ringostat Smart Phone та книгу контактів

Цей метод дасть змогу передавати інформацію від CRM, що інтегруються за Webhook, для відображення інформації про клієнта в книзі контактів Ringostat Smart Phone та журнал дзвінків.

За допомогою цього методу можна відправляти:

- Ім'я

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

- Email

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

Основні параметри запиту:

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

ідентифікатор клієнта з 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.

Основні параметри запиту:

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

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

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

Ви отримали відповідь на своє запитання?