Цей метод дозволить наповнювати кампанії Power Dialer за допомогою API
Основні параметри запиту:
Адреса API-запиту: https://api.ringostat.net/power-dialer/campaigns/campaign-rows
Метод: POST
Auth-key: електронний ключ для доступу до вашого проєкту в Ringostat.
projectId: ID проєкту
Для того, щоб наповнювати Кампанію в Power dialer, її треба створити.
Для цього треба перейти в розділ “Налаштування” > “Налаштування Ringostat Smart Phone” > “Power Dialer”.
2. В налаштуваннях “Power Dialer” натиснути “+Додати кампанію”, ввести назву Кампанії і зберегти.
3. Після цього необхідно натиснути на три вертикальні крапки справа від назви і викликати контекстне меню, в ньому обрати “Редагувати список номерів кампанії”.
Ви потрапите на сторінку, де вам буде запропоновано завантажити список номерів кампанії, проте робити цього не треба.
Необхідно скопіювати URL сторінки, він буде виглядати приблизно так:
Для майбутнього методу нам знадобляться значення параметрів:
projectId - його значення треба передати в Headers в x-project-id
editCampaign - його значення треба передати в Body в "campaignId".
4. Ключ авторизації, який необхідний для наповнення кампанії за допомогою API ви можете знайти перейшовши на сторінку “Налаштування” > “Інтеграція” > “Ringostat API”. На цій сторінці необхідно скопіювати Auth-key, щоб передати його в Headers в Auth-key.
5. Для того, щоб наповнити Кампанію номерами по API, треба звертатись до:
URL | |
Headers | x-project-id: 123 Auth-key: xxx Content-Type: application/json |
Metod | POST |
Body | { "campaignId": 456, "fio": "name", "phone_number": "380930000000" } |
campaignId ми беремо із URL сторінки https://power-dialer.ringostat.com/campaign/edit?projectId=123&editCampaign=456&campaignName=ddd - тут наприклад 456
Параметр fio - опціональний, його можна не передавати.
Параметр phone_number обовʼязковий, при цьому номер обов'язково має бути в міжнародному форматі: +380YYXXXXXXX
Приклад для Node.js:
const https = require('https');
const data = JSON.stringify({
campaignId: 456,
fio: "Іван Петренко",
phone_number: "380930000000"
});
const config = {
host: 'api.ringostat.net',
path: '/power-dialer/campaigns/campaign-rows',
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Content-Length': Buffer.byteLength(data),
'x-project-id': '123',
'Auth-key': 'your_unique_auth_key'
}
};
const callback = (response) => {
let result = Buffer.alloc(0);
response.on('data', chunk => {
result = Buffer.concat([result, chunk]);
});
response.on('end', () => {
console.log(result.toString());
});
};
const request = https.request(config, callback);
request.write(data);
request.end();
Приклад для Axios.js
const axios = require('axios');
axios({
url: 'https://api.ringostat.net/power-dialer/campaigns/campaign-rows',
method: 'POST',
headers: {
'Content-Type': 'application/json',
'x-project-id': '123',
'Auth-key': 'xxx'
},
data: {
campaignId: 456,
fio: "Іван Петренко",
phone_number: "380930000000"
}
})
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error(error.response?.data || error.message);
});
Приклад для cURL
curl -X POST "https://api.ringostat.net/power-dialer/campaigns/campaign-rows" \
-H "Content-Type: application/json" \
-H "x-project-id: 123" \
-H "Auth-key: xxx" \
-d '{
"campaignId": 456,
"fio": "Іван Петренко",
"phone_number": "380930000000"
}'
Результат:
{
"result": true
}
Обмеження:
Максимум 1 номер за 1 запит
Значення параметрів fio і phone_number ви маєте брати зі своєї CRM.