API арқылы контактілер
API арқылы контактілер тізімін алуға, сондай-ақ оларды бағдарламалық түрде қосуға немесе жаңартуға болады, мысалы, клиенттер базаңызды вебхуктар арқылы синхрондау үшін.
POST /v1/contacts: контактілерді құру немесе жаңарту
Көрсетілген байланыс желісіне жаңа контактілерді қосады және бар контактілердің атын жаңартады.
URL
POST https://api.wazzabee.com/api-gateway/v1/contacts
Тақырыптар
Authorization: Bearer СІЗДІҢ_API_КІЛТІҢІЗ
Content-Type: application/json
Сұрау денесі: бір контакт
{
"channel_id": "Байланыс желісінің UUID",
"phone": "+996550202160",
"name": "Диана"
}
Сұрау денесі: тізім (бір ретте 1000-ға дейін)
{
"channel_id": "Байланыс желісінің UUID",
"contacts": [
{ "phone": "+996550202160", "name": "Диана" },
{ "phone": "77011234567", "name": "Иван" }
]
}
Параметрлер
| Параметр | Түрі | Міндетті | Сипаттама |
|---|---|---|---|
channel_id | string (UUID) | ✅ Иә | Байланыс желісінің ID. Оны GET /v1/channels арқылы алуға болады |
phone | string | ✅ Иә | Кез келген форматтағы нөмір: артық таңбалар (+, бос орындар, жақшалар) алынып тасталады |
name | string | Жоқ | Контакт аты. Көрсетілмесе: жаңа контактінің аты нөмір болады, бар контактінің аты өзгермейді |
Жұмыс тәртібі
- Желіде мұндай нөмірлі контакт жоқ болса, ол құрылады.
- Контакт бар болса және
nameберілсе, тек аты жаңартылады. Жазбалар, аватар және басқа деректер өзгермейді. - Нөмір тек цифрларға келтіріледі; бір сұраудағы қайталанған нөмірлер біріктіріледі.
Жауап
{ "success": true, "added": 2, "updated": 0, "skipped": 0 }
🔒 Деректерді оқшаулау: контактілер тек Сіздің байланыс желіңізге қосылады. Өз API кілтіңіз арқылы басқа аккаунттың контактілерін жазу немесе көру мүмкін емес.
Мысал (curl)
curl -X POST https://api.wazzabee.com/api-gateway/v1/contacts \
-H "Authorization: Bearer СІЗДІҢ_API_КІЛТІҢІЗ" \
-H "Content-Type: application/json" \
-d '{"channel_id":"UUID","phone":"+996550202160","name":"Диана"}'
GET /v1/contacts: контактілер тізімі
Контактілерді беттеу және іздеу мүмкіндігімен қайтарады.
GET https://api.wazzabee.com/api-gateway/v1/contacts?limit=50&offset=0&search=Диана
| Параметр | Сипаттама |
|---|---|
limit | Қанша қайтару керек (1–200, әдепкі бойынша 50) |
offset | Беттеуге арналған ығысу |
channel_id | Міндетті емес: тек осы желінің контактілері |
search | Аты немесе нөмірі бойынша іздеу |
Жауап
{
"success": true,
"contacts": [
{ "id": "...", "name": "Диана", "phone": "996550202160", "channelId": "...", "channelType": "whatsapp_qr" }
],
"total": 120
}