API құжаттамасы

Аутентификация

Кілтті Developer → API keys бөлімінде жасап, bearer token ретінде жіберіңіз. Кілт сервердің құпиясы: оны браузердегі JavaScript-ке немесе мобильді қосымшаға ешқашан салмаңыз.

Authorization: Bearer cv_live_xxxxxxxxxxxx

cv_test_ кілті бүкіл үдерісті өтеді, бірақ SIM мен мессенджерлерге тимейді, сондықтан кредит жұмсамай интеграция жасай аласыз. ChatVendor 2.0-ге дейін берілген sms_ кілттері жұмысын жалғастырады.

Scope-тар

Әр кілттің scope-тары бар, әр эндпоинт өзіне қажет scope-ты көрсетеді. Мессенджер эндпоинттеріне API қолжетімді тариф та керек.

Жауап форматы

Base URL https://chatvendor.net/api/v1. Әр жауап success белгісі бар JSON. Тізімдерде беттеуі бар meta нысаны болады. Қателер әрқашан бір форматта келеді: шешімді хабар мәтініне емес, code мәніне қарап қабылдаңыз.

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

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

Алғашқы сұранысыңыз

1. 01

   Арнаны қосыңыз

   SMS үшін Android телефонын жұптаңыз немесе Telegram / WhatsApp / Instagram аккаунтын қосыңыз.

2. 02

   Кілт жасаңыз

   Тек қажет scope-тарды белгілеңіз. Тест кілтінен бастаңыз.

3. 03

   API-ге сұраныс жіберіңіз

   Арналар тізімін алыңыз, содан кейін хабар жіберіңіз. Екі сұраныс төменде.

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"}'