1. Перевірка доступності SIP-акаунта
Цей метод дозволяє визначити які sip-акаунти активні. Повертає масив з логінами sip-акаунтів, що у статусі "Online".
Опис параметрів запиту:
Адреса API-запиту: https://api.ringostat.net/sipstatus/online
API формат: json;
Метод: GET.
Auth-key: це електронний ключ для доступу до вашого проекту Ringostat.
Приклад для Node.js:
const https = require('https');
const config = {
host: 'api.ringostat.net',
path: '/sipstatus/online',
method: 'GET',
headers: {
'Auth-key': 'unique_auth_key_string'
}
};
const callback = response => {
let result = Buffer.alloc(0);
response.on('data', chunk => {
result = Buffer.concat([ result, chunk ]);
});
response.on('end', () => {
//handle response
});
};
const request = https.request(config, callback);
request.end();
Приклад для Axios.js
axios({
url: 'https://api.ringostat.net/sipstatus/online',
method: 'GET',
headers: {
'Auth-key': 'unique_auth_key_string'
}
}).then(response => {
//handle response
}).catch(error => {
//handle error
})
Приклад для cURL
curl "https://api.ringostat.net/sipstatus/online" \
-H "Auth-key: unique_auth_key_string"
Результат:
[
"supportrngst_manager1",
"supportrngst_manager2",
"supportrngst_manager3",
"supportrngst_manager4",
"supportrngst_manager5",
"supportrngst_manager6",
"supportrngst_manager7"
]
2. Перевірка доступності SIP-акаунта в Ringostat Smart Phone
Даний метод дозволяє визначити, які sip-акаунти активні у розширенні Ringostat Smart Phone. Повертає масив з логінами sip-акаунтів, що у статусі "Online".
Опис параметрів запиту
Метод: GET.
Auth-key: це електронний ключ для доступу до вашого проекту Ringostat.
project_id: Параметр project_id можна знайти на будь-якій сторінці особистого кабінету в рядку Url.
Приклад для Node.js:
const https = require('https');
const config = {
host: 'api.ringostat.net',
path: '/sipstatus/online?project_id={your_project_id}&token={token}&withRspDoNotDisturbSips=false',
method: 'GET',
headers: {
'Auth-key': 'unique_auth_key_string'
}
};
const callback = response => {
let result = Buffer.alloc(0);
response.on('data', chunk => {
result = Buffer.concat([ result, chunk ]);
});
response.on('end', () => {
//handle response
});
};
const request = https.request(config, callback);
request.end();Приклад для Axios.js
axios({
url: 'https://api.ringostat.net/sipstatus/online?project_id={your_project_id}&token={token}&withRspDoNotDisturbSips=false',
method: 'GET',
headers: {
'Auth-key': 'unique_auth_key_string'
}
}).then(response => {
//handle response
}).catch(error => {
//handle error
})
Приклад для cURL
curl "https://api.ringostat.net/sipstatus/online?project_id={your_project_id}&token={token}&withRspDoNotDisturbSips=false" \
-H "Auth-key: unique_auth_key_string"
Результат:
[
"supportrngst_manager1",
"supportrngst_manager2",
"supportrngst_manager3",
"supportrngst_manager4",
"supportrngst_manager5",
"supportrngst_manager6",
"supportrngst_manager7"
]
3. Перевірка наявності активного дзвінка у SIP-акаунта
Даний метод дозволить визначити які sip-акаунти не зайняті. Повертає масив логінів sip-акаунтів проекту, які зараз розмовляють.
Опис параметрів запиту
Адреса API-запиту: https://api.ringostat.net/sipstatus/speaking
API формат: json;
Метод: GET.
Auth-key: це електронний ключ для доступу до вашого проекту Ringostat.
Приклад для Node.js:
const https = require('https');
const config = {
host: 'api.ringostat.net',
path: '/sipstatus/speaking',
method: 'GET',
headers: {
'Auth-key': 'unique_auth_key_string'
}
};
const callback = response => {
let result = Buffer.alloc(0);
response.on('data', chunk => {
result = Buffer.concat([ result, chunk ]);
});
response.on('end', () => {
//handle response
});
};
const request = https.request(config, callback);
request.end();
Приклад для Axios.js
axios({
url: 'https://api.ringostat.net/sipstatus/speaking',
method: 'GET',
headers: {
'Content-Type': 'application/json; charset=utf-8',
'Auth-key': 'unique_auth_key_string'
}
}).then(response => {
//handle response
}).catch(error => {
//handle error
})
Приклад для cURL
curl "https://api.ringostat.net/sipstatus/speaking" \
-H "Auth-key: unique_auth_key_string"
Результат:
[
"supportrngst_manager2",
"supportrngst_manager4",
"supportrngst_manager5",
"supportrngst_manager7"
]