@callpromn/rtc-sdk
v0.0.3
Published
CallPro SDK for Web
Readme
RTC-SDK
RTC-SDK нь CallPro компанийн боловсруулсан, дуудлагын үйлчилгээг хурдан, шууд нэгтгэх зориулалттай SDK юм.
Энэхүү санг ашигласнаар та өөрийн системд дэлхийн хаанаас ч үүрэн болон суурин утас руу дуудлага хийх, хүлээн авах боломжийг нэмэх боломжтой.
Суулгах
RTC-SDK-ийг суулгах
npm install @callpromn/rtc-sdkBadges
🚀 Quickstart
import CallClient from '@callpromn/rtc-sdk';
// CallClient үүсгэх
const callClient = CallClient();
// Client-ын instance үүсгэх
const callClientInstance = await callClient.createClient(config);
// Гарах дуудлага хийх
await callClientInstance.createCall('12345678');⚙️ Тохиргоо
const config = {
socketUrl: 'wss://example.callpro.mn',
socketToken: 'token',
socketConnectionOptions: {}, // (optional) socket.io холболтын тохиргоо
phoneNumber: '12345678', // таны утасны дугаар
outboundRoom: 'outboundRoom', // гарах дуудлагын өрөө
inboundRoom: 'inboundRoom', // орох дуудлагын өрөө
};APIs
import CallClient from '@callpromn/rtc-sdk';
const callClient = CallClient();
const callClientInstance = await callClient.createClient(config);📤 Гарах дуудлага
await callClientInstance.createCall('утасны_дугаар'); // Залгах дугаараа оруулан залгах📥 Орох дуудлага
await callClientInstance.acceptCall(); // Ирж буй дуудлагыг хүлээж авах
await callClientInstance.declineCall(); // Ирж буй дуудлагыг хүлээж авахгүй байхБусад хийх боломжтой үйлдлүүд
isConnected()
await callClientInstance.isConnected();Socket сервертэй холбогдсон эсэхийг шалгана.
endCall()
await callClientInstance.endCall();Идэвхтэй явагдаж буй дуудлагыг дуусгана.
toggleMic()
await callClientInstance.toggleMic();Микрофоныг нээх/хаах (mute/unmute) үйлдэл хийнэ.
getInboundUserData()
await callClientInstance.getInboundUserData();Залгаж буй хэрэглэгчийн мэдээллийг авах
Эвентүүд
RTC-SDK нь хэрэглэгчид рүү бодит цагын(real-time) эвентүүд илгээдэг. Эдгээр эвентүүдийг callClientInstance.on(eventName, callback) хэлбэрээр сонсож ашиглана.
| Эвент нэр | Параметр | Тайлбар |
| --------------- | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| call_init | "incoming" эсвэл "outbound" | Дуудлага эхлэх үед үүснэ. "incoming" нь хэрэглэгч рүү орох дуудлага ирж байгааг, "outbound" нь хэрэглэгч гарах дуудлага хийж байгааг илэрхийлнэ. |
| ringing | - | Дуудлага холбогдох гэж байх үед (дуугарч байх үед) үүснэ. |
| answered | - | Нөгөө тал дуудлагыг хүлээж авсан үед үүснэ. |
| busy | - | Хүлээн авагчийн утас завгүй үед үүснэ. |
| hangup | - | Дуудлага дууссан үед (аль ч талаас тасалсан) үүснэ. |
Жишээ
callClientInstance.on('call_init', (direction) => {
if (direction === 'incoming') {
console.log('📥 Орох дуудлага ирлээ');
} else if (direction === 'outbound') {
console.log('📤 Гарах дуудлага эхэллээ');
}
});
callClientInstance.on('ringing', () => {
console.log('Дуудлага дугарч байна...');
});
callClientInstance.on('answered', () => {
console.log('Дуудлага хүлээж авлаа');
});
callClientInstance.on('busy', () => {
console.log('Хүлээн авагч завгүй байна');
});
callClientInstance.on('hangup', () => {
console.log('Дуудлага дууслаа');
});Холбоотой төслүүд
RTC-SDK-ын Prebuild(UI) хувилбарууд
- RTC-Kit
- RTC-Kit-React
- RTC-Kit-Angular (coming soon)
- RTC-Kit-VueJS (coming soon)
- RTC-Kit-Svelte (coming soon)
RTC-SDK-ын No-Code хувилбар
- No-Code хувилбар (coming soon)
RTC-SDK-ын бусад хувилбарууд
- RTCKit-iOS (coming soon)
- RTCKit-Android (coming soon)
🔗 Холбоосууд
Холбоо барих, Тусламж
- Бидэнтэй холбоо барих: CallPro
- Бүтээгдэхүүнтэй холбоотой асуулт, зөвлөгөө, тусламж авах: [email protected]
