Этот метод позволит наполнять кампании 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 – его значение надо передать в Заголовки в x-project-id
editCampaign – его значение надо передать в Тело в "campaignId".
4. Ключ авторизации, необходимый для наполнения кампании с помощью API, можно найти на странице “Настройки” > “Интеграция” > “Ringostat API”. На этой странице необходимо скопировать Auth-key, чтобы передать его в Заголовки в Auth-key.
5.Для того чтобы наполнить кампанию номерами по API, нужно обращаться к:
URL | |
Заголовки | x-project-id: 123 Auth-key: xxx Content-Type: application/json |
Метод | POST |
Тело | { "campaignId": 456, "fio": "name", "номер_телефона": "380930000000" } |
campaignId мы берем из URL страницы https://power-dialer.ringostat.com/campaign/edit?projectId=123&editCampaign=456&campaignName=ddd - здесь например 456
Параметр fio – опциональный, его можно не передавать.
Параметр phone_number обязателен, при этом номер обязательно должен быть в международном формате: +380YYXXXXXXX
Example for Node.js:
const https = require('https');
const data = JSON.stringify({
campaignId: 456,
fio: "Ivan Petrenko",
Phone number: "380930000000"
});
const config = {
host: 'api.ringostat.net',
путь: '/power-dialer/campaigns/campaign-rows',
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Content-Length': Buffer.byteLength(data),
'x-project-id': '123',
'Authorization Key': 'your_unique_authorization_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();
Example for 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',
'Authorization Key': 'xxx'
},
data: {
campaignId: 456,
fio: "Ivan Petrenko",
Phone number: "380930000000"
}
})
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error(error.response?.data || error.message);
});
Example for cURL
curl -X POST "https://api.ringostat.net/power-dialer/campaigns/campaign-rows" \
-H "Content-Type: application/json" \
-H "x-project-id: 123" \
-H "Authorization Key: xxx" \
-d '{
"campaignId": 456,
"fio": "Ivan Petrenko",
"phone_number": "380930000000"
}'
Result:
{
"result": true
}
Ограничение:
Максимум 1 номер за 1 запрос
Значение параметров fio и phone_number вы должны брать из своей CRM.