Хабарламаларды жіберу

    6 мин оқу
    ·
    423 қаралым
    ·
    Жаңартылды: 10/23/2026

    POST /v1/messages/send

    Қосылған арна (байланыс желісі) арқылы мәтіндік немесе медиа хабарлама жіберу.

    ℹ️ Асинхронды жіберу: Хабарламалар кезекке қойылып, бірнеше секунд ішінде жіберіледі. Сәтті жауап (202) хабарламаның өңдеуге қабылданғанын білдіреді, бірақ оның жеткізілгенін білдірмейді.

    URL

    POST https://api.wazzabee.com/api-gateway/v1/messages/send

    Тақырыптар (headers)

    Authorization: Bearer СІЗДІҢ_API_КІЛТІҢІЗ
    Content-Type: application/json

    Сұраныс денесінің параметрлері

    ПараметрТүріМіндеттіСипаттама
    channelIdstring (UUID)✅ ИәАрнаның (байланыс желісінің) ID-і. GET /v1/channels арқылы алуға болады
    chatIdstring✅ ИәАлушының идентификаторы: телефон нөмірі (WhatsApp үшін) немесе chat_id (Telegram үшін)
    textstring✅*Хабарлама мәтіні. mediaUrl көрсетілмесе, міндетті
    mediaUrlstring (URL)✅*Медиафайлға тікелей сілтеме (сурет, бейне, құжат). text көрсетілмесе, міндетті
    mediaTypestringШартты түрдеМедиа түрі: photo, video, document, audio. mediaUrl көрсетілгенде міндетті
    captionstringЖоқМедиафайлға жазба. Тек mediaUrl-мен бірге жұмыс істейді
    senderNamestringЖоқАвтордың аты: хабарламаны кім жібергені. WazzaBee чатында операторларыңызға көрінеді және вебхукта келеді. Клиентке мессенджерде берілмейді
    userIdstringЖоқСіздің CRM-дегі қызметкердің идентификаторы. Оны өзгеріссіз қайтарамыз, бұл қызметкерді WazzaBee-ге тіркеудің қажеті жоқ
    automatedbooleanЖоқtrue: хабарламаны робот, автожауап немесе еске салғыш жіберді. Чатта мұндай хабарлама автоматты деп белгіленеді
    campaignIdstringЖоқСіздің науқан белгіңіз, 100 таңбаға дейін. Жауапта, шығыс хабарламалар, мәртебелер және батырма басу вебхуктарында қайтарылады. Ол бойынша GET /v1/messages сүзуге және кабинетте жіберулерді жүктеп алуға болады: «Коннекторлар» → «API» → «API арқылы жіберулерді жүктеу»

    * text немесе mediaUrl өрістерінің кемінде біреуін көрсету қажет.

    Хабарламаны кім жіберді

    Әдепкі бойынша API арқылы жіберілген хабарлама чатта қысқа ғана «API арқылы» деп, атсыз белгіленеді. Егер CRM-іңіз авторды білсе, оны беріңіз: хабарламаның астында «API арқылы · Назерке А.» деп көрінеді, ал аты messages_outgoing вебхугында сізге қайтарылады. Осылайша чат лентасынан клиентке қай менеджер жауап бергені түсінікті болады.

    curl -X POST "https://api.wazzabee.com/api-gateway/v1/messages/send" \
      -H "Authorization: Bearer СІЗДІҢ_API_КІЛТІҢІЗ" \
      -H "Content-Type: application/json" \
      -d '{
        "channelId": "550e8400-e29b-41d4-a716-446655440000",
        "chatId": "77001234567",
        "text": "Сәлеметсіз бе! Құжаттарыңыз дайын.",
        "senderName": "Назерке Ахметова",
        "userId": "manager-42"
      }'

    senderName және userId орнына author нысанын беруге болады, нәтиже бірдей:

    {
      "channelId": "550e8400-e29b-41d4-a716-446655440000",
      "chatId": "77001234567",
      "text": "Сәлеметсіз бе!",
      "author": { "id": "manager-42", "name": "Назерке Ахметова" }
    }

    Адам жібермейтін хабарламаларды (роботтар, автожауаптар, еске салғыштар) "automated": true деп белгілеңіз: чатта олар менеджерлердің жауаптарынан бөлек көрінеді.

    ℹ️ Қолтаңба тек сізге көрінеді. Автордың аты WazzaBee чатында операторларыңызға көрсетіледі және вебхуктарда келеді. Клиентке WhatsApp немесе Telegram-да ол берілмейді: клиент тек хабарлама мәтінін көреді.

    chatId форматы

    Арна түріchatId форматыМысал
    WhatsApp (QR)Ел коды бар телефон нөмірі, + белгісінсіз77001234567
    WhatsApp (WABA)Ел коды бар телефон нөмірі, + белгісінсіз77001234567
    Telegram BotПайдаланушының сандық chat_id-і123456789
    Telegram PersonalСандық chat_id немесе @ белгісінсіз username123456789 немесе ivanivanov

    Сұраныс мысалдары

    Мәтіндік хабарлама

    curl -X POST "https://api.wazzabee.com/api-gateway/v1/messages/send" \
      -H "Authorization: Bearer СІЗДІҢ_API_КІЛТІҢІЗ" \
      -H "Content-Type: application/json" \
      -d '{
        "channelId": "550e8400-e29b-41d4-a716-446655440000",
        "chatId": "77001234567",
        "text": "Сәлеметсіз бе! №1234 тапсырысыңыз беруге дайын."
      }'

    Жазбасы бар сурет

    curl -X POST "https://api.wazzabee.com/api-gateway/v1/messages/send" \
      -H "Authorization: Bearer СІЗДІҢ_API_КІЛТІҢІЗ" \
      -H "Content-Type: application/json" \
      -d '{
        "channelId": "550e8400-e29b-41d4-a716-446655440000",
        "chatId": "77001234567",
        "mediaUrl": "https://example.com/photo.jpg",
        "mediaType": "photo",
        "caption": "Тапсырысыңыздың суреті"
      }'

    Құжат

    curl -X POST "https://api.wazzabee.com/api-gateway/v1/messages/send" \
      -H "Authorization: Bearer СІЗДІҢ_API_КІЛТІҢІЗ" \
      -H "Content-Type: application/json" \
      -d '{
        "channelId": "550e8400-e29b-41d4-a716-446655440000",
        "chatId": "77001234567",
        "mediaUrl": "https://example.com/invoice.pdf",
        "mediaType": "document"
      }'

    Сәтті жауап (202 Accepted)

    {
      "success": true,
      "queued": true,
      "queueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "message": "Сообщение поставлено в очередь на отправку"
    }
    ӨрісТүріСипаттама
    successbooleanСәтті болғанда әрқашан true
    queuedbooleanХабарлама кезекке қабылданды
    queueIdstring (UUID)Жіберу кезегіндегі бірегей ID. Дәл осы queueId жеткізу мәртебелерінің вебхугында (messages_status) және GET /v1/messages-те келеді: ол арқылы хабарламаның жеткенін білесіз
    campaignIdstring | nullНауқан белгісі, егер берілген болса
    messagestringНәтиженің мәтіндік сипаттамасы

    Ықтимал қателер

    КодҚатеСебебі
    400Невалидный JSON в теле запросаСұраныс денесі дұрыс JSON емес
    400Поле channelId обязательноchannelId параметрі берілмеген
    400Поле chatId обязательноchatId параметрі берілмеген
    400Нужно указать text или mediaUrlМәтін де, медиафайл да берілмеген
    400Канал неактивенАрна өшірілген немесе бапталмаған
    400Неподдерживаемый тип каналаАрна түрін API қолдамайды
    403Канал не привязан к данной интеграцииАрна осы API кілтіне рұқсат етілгендердің қатарына кірмейді
    404Канал не найден или нет доступаАрна жоқ немесе басқа пайдаланушыға тиесілі

    Іштей қалай жұмыс істейді

    1. API авторизацияны және арнаға қолжетімділікті тексереді
    2. chatId бойынша контактіні іздейді (телефон немесе external_id). Табылмаса, жаңасын жасайды
    3. Бар диалогты (conversation) іздейді. Табылмаса, жаңасын жасайды
    4. Арна түріне қарай жеткізу тәсілін анықтайды
    5. Хабарламаны message_queue кезегіне қояды
    6. Фондық процесс хабарламаны кезектен алып, провайдер арқылы жібереді

    Жаңа желінің қосылуын тексеру

    Жұмыс интеграциясының алдында қысқа тексеруден өтіңіз: ол бір минут алады және алмасу қай жерде тоқтағанын бірден көрсетеді.

    1. Желі API-де көрінеді. GET /v1/channels сұратып, қажетті желінің жауапта бар екеніне және оның status мәні active екеніне көз жеткізіңіз. Сынақ кезеңі қабылдау мен жіберуге кедергі келтірмейді.
    2. Шығыс хабарлама. POST /v1/messages/send сұранысын өзіңіздің екінші аккаунтыңызға жіберіңіз. Жауапта queueId келеді: бұл кезектегі тапсырма нөмірі, жеткізуді растау емес.
    3. Жіберу нәтижесі. Вебхукта messages_status және messages_outgoing оқиғаларына жазылыңыз: queueId бойынша қорытынды дәл сол жерден келеді. Хабарлама кабинет чаттарында да пайда болады.
    4. Кіріс хабарлама. Желіге басқа аккаунттан жазыңыз. Хабарлама кабинет чаттарында пайда болып, messages_incoming вебхугына келуі тиіс. Егер кабинетте бос болса, мәселе сіздің кодыңызда емес: қолдау қызметіне жазып, жіберу уақыты мен желі мекенжайын қоса жіберіңіз.
    ℹ️ Жеке Telegram. Желі сіздің Telegram аккаунтыңыз арқылы жұмыс істейді, сондықтан мессенджердің әдеттегі шектеулері қолданылады: бірінші болып тек бейтаныс адамдардан хабарлама алуға ашық пайдаланушыларға ғана жазуға болады, ал жаңа сұхбаттастарға тым жиі жазғанда Telegram баяулатады. Жаппай хабарландырулар үшін Telegram Bot желісін немесе WhatsApp Business API пайдаланыңыз.