API hujjatlari

SMS va messenjer endpointlari uchun bitta kalit, bitta bazaviy URL, bitta javob shakli.

Bazaviy URL: https://chatvendor.net/api/v1. Kalitni Bearer token sifatida yuboring. Har bir javob {"success": true, "data": …} yoki {"success": false, "error": {"code", "message"}} ko'rinishida.

Kalitlar panelda Dasturchi → API kalitlar bo'limida yaratiladi: kalit nima qila olishini cheklaydigan scope'lar va muhit — live yoki test.

01
Kalit yarating
Dasturchi → API kalitlar → Yangi kalit. Bir marta nusxalang; keyin faqat prefiks ko'rinadi.
02
So'rov yuboring
curl https://chatvendor.net/api/v1/me -H "Authorization: Bearer cv_live_…"
03
Hodisalarni tinglang
Webhook URL ro'yxatdan o'tkazing va X-ChatVendor-Signature sarlavhasini tekshiring.

Qanday boshlash

Kalitlar, scope'lar, javob formati va birinchi so'rovingiz.

Autentifikatsiya

Developer → API kalitlar bo'limida kalit yarating va bearer token sifatida yuboring. Kalit server-server uchun — uni brauzer JavaScript yoki mobil ilovaga qo'ymang.

Authorization: Bearer cv_live_xxxxxxxxxxxx

cv_test_ kalit to'liq oqimni bajaradi, lekin SIM yoki messenjerga tegmaydi — kredit sarflamasdan integratsiya qilasiz. ChatVendor 2.0 dan oldingi sms_ kalitlar ishlayveradi.

Scope'lar

Har kalitda scope'lar bor; har endpoint kerakli scope'ni ko'rsatadi. Messenjer endpointlariga API'li tarif ham kerak.

messages:sendXabar yuborish

messages:readXabarlarni ko'rish

devices:readTelefonlarni ko'rish

devices:manageTelefonlarni boshqarish

webhooks:manageWebhook'larni boshqarish

analytics:readStatistikani ko'rish

channels:readTarmoqlar va chatlarni o'qish

channels:writeChatlarga yozish

leads:readLidlarni o'qish

leads:writeLidlarni boshqarish

scenarios:manageSsenariy ijrolarini boshqarish

ai:useAI ishlatish

Javob formati

Base URL https://chatvendor.net/api/v1. Har javob success bayrog'i bilan JSON; ro'yxatlarda sahifalash uchun meta obyekti bor. Xatolar doim bir formatda — code bo'yicha tarmoqlang, xabar matni bo'yicha emas.

{
  "success": true,
  "data": { "id": "msg_01j…", "status": "queued" }
}

{
  "success": false,
  "error": { "code": "INVALID_API_KEY", "message": "…" }
}

Birinchi so'rovingiz

01
Tarmoq ulang
SMS uchun Android telefon ulang yoki Telegram / WhatsApp / Instagram akkaunt ulang.
02
Kalit yaratish
Faqat kerakli scope'larni belgilang; test kalitdan boshlang.
03
So'rov yuboring
Tarmoqlaringizni oling, keyin xabar yuboring — quyidagi ikki so'rov.

curl https://chatvendor.net/api/v1/channels -H "Authorization: Bearer cv_live_xxxxxxxxxxxx"

curl -X POST https://chatvendor.net/api/v1/channels/1/dialogs/@username/messages \
  -H "Authorization: Bearer cv_live_xxxxxxxxxxxx" -H "Content-Type: application/json" \
  -d '{"text": "Salom! Bu API orqali yuborildi."}'

curl -X POST https://chatvendor.net/api/v1/messages \
  -H "Authorization: Bearer cv_live_xxxxxxxxxxxx" -H "Content-Type: application/json" -H "Idempotency-Key: order-1234" \
  -d '{"to": "+998901234567", "message": "Your code is 483921"}'

Bo'limlar bo'yicha ma'lumotnoma

SMS 6 endpointO'z Android telefoningiz orqali SMS navbatga qo'ying, holatini tekshiring, qurilmalar ro'yxatini oling. Telegram: chatlar va xabarlar 24 endpointUlangan Telegram akkauntning (user yoki bot) chatlari, xabarlari, fayllari, mediasi, kontaktlari va qidiruvi. Telegram: guruhlar va kanallar 8 endpointGuruh va kanallarning a'zolari, qo'shilish havolalari, forum mavzulari, sozlamalari va taklif havolalari. Telegram: stikerlar, papkalar, Business, raw 15 endpointStiker to'plamlari, saqlangan GIF'lar, chat papkalari, Telegram Business va connector'ning har bir endpointiga o'tkazgich. WhatsApp 7 endpointWhatsApp Business raqamining chatlari, xabarlari, fayllari va shablonlari (wa_{id}). Instagram 5 endpointInstagram akkauntning Direct xabarlari, kommentga javoblar, storis javoblari va fayllari (ig_{id}). Messenger, Viber, sayt chati 6 endpointFacebook sahifa (fb_{id}), Viber bot (vb_{id}) va sayt vidjeti (web_{id}) uchun xuddi shu chat endpointlari. Kontaktlar (CRM kartasi) 7 endpointHar kontaktning teglari, o'zgaruvchilari, ballari, referallari va kuzatiladigan havolalari — Telegram, WhatsApp va Instagram'da bir xil. Sotuvlar va to'lovlar 6 endpointChat-bot ichida mahsulotlar, buyurtmalar va to'lovlar: Payme, Click, Telegram Stars yoki qo'lda. Bandlovlar 5 endpointXizmatlar, bo'sh vaqtlar va qabullar — «Vaqtga yozish» qadami ishlatadigan narsalar. Segmentlar, kampaniyalar, vazifalar 9 endpointKontakt kartochkasi bo'yicha auditoriyalar, A/B qadamli drip-kampaniyalar va jamoa uchun eslatmalar. Lidlar 5 endpointQoidalar va AI yig'gan lidlar: holat, ball, teglar va xulosa. Ssenariylar 2 endpointKo'p qadamli oqimlaringiz ijrolari: ro'yxat, kutayotgan qadamni tasdiqlash yoki rad etish. AI 3 endpointO'z provayder kalitingiz bilan chat va media tahlili. Webhook'lar 4 endpointHodisa bo'lganda xabar oling: hodisalar, payload, imzo, qayta urinishlar. Xatolar va limitlar Xato formati, har bir xato kodi va HTTP holati, limitlar qanday ishlashi. SDK va kod misollari PHP SDK, WordPress plagini va PHP, Node.js, Python'da tayyor misollar.

Savollar

SDK bormi?

Ha — Composer orqali PHP paketi va WordPress plagini; boshqa tillar OpenAPI hujjatidan mijoz yaratishi mumkin.

Limitlar qayerda yozilgan?

Quyidagi limitlar bo'limida va X-RateLimit-Limit hamda X-RateLimit-Remaining javob sarlavhalarida.