API oluşturucu

29.06.2026

Bu sayfada

Bazı API istek fonksiyonları Hesap Makinesi'nde çalıştırılabilir.

İstekler, aşağıdaki formattaki bir URL'ye POST veya GET yöntemiyle gönderilir:

https://chatter.mavibot.ai/api/{api\_key}/{action}

Burada:

api_key — proje ayarlarında oluşturulan API erişim anahtarı.

Belirteci bir URL isteğinde kullanmak için önce bir API anahtarı oluşturmanız gerekir.

Bunun nasıl yapılacağına ilişkin talimatlar "API Anahtarı Oluşturma" bölümünde verilmiştir. bağlantı

Bu sayfadan bir URL kopyalarken bir boşluk görünebilir ve kaldırılması gerekir.

Hatalı bağlantı örneği:
https://chatter.mavibot.pro /api/callback

.pro'dan sonraki boşluk kalırsa istek çalışmaz.

GET isteği gönderirken yasaklı karakterler kullanmayın.

GET istekleri için doğru formatı anladığınızdan emin olun.

API anahtarı nasıl oluşturulur

Eski API anahtarı oluşturma özelliği eskisi gibi çalışmaya devam ediyor ancak yeni projeler için kullanılamaz.

Projenizde bu bölümde açıklanan erişim ayarları olmadan oluşturulmuş API anahtarları zaten varsa, bu mevcut API anahtarları normal şekilde çalışmaya devam edecektir.

Yeni anahtarlar oluşturmanız gerekiyorsa güncellenmiş ayarları kullanın.

API anahtarı oluşturmak için proje ayarlarına gidin:

Ardından, "Entegrasyonlar" bölümüne gidin:

"API anahtarı ekle" düğmesini "Entegrasyonlar" bölümünde bulacaksınız:

Düğmeye tıkladıktan sonra, erişim ayarları ve API anahtarı oluşturma seçeneklerini içeren bir modal pencere açılacaktır:

Ardından, API anahtarı için erişim izinlerini seçmeniz gerekir:

API işlevi, seçtiğiniz erişim izinlerine göre çalışacaktır.

Lütfen dikkat!

API işlevi, belirlediğiniz erişim izinlerine bağlıdır: yalnızca müşteri bilgilerine okuma erişimi olan bir API anahtarı oluşturur ve ardından bunu bir müşteriye mesaj göndermek veya değişkenlerini değiştirmek için kullanırsanız, API isteği başarısız olur.
Her API isteği için gerekli izin, API istek kartında belirtilir:

Ardından, API anahtarı için bir ad girin:

"Oluştur" düğmesine tıklayarak API anahtarını oluşturun:

Ardından "Bitti"ye tıklayın ve api anahtarı bölüme eklenecektir:

İhtiyacınız olduğu kadar çok API anahtarı ekleyebilir ve her birine farklı erişim izinleri atayabilirsiniz.

Ardından, bir birincil proje anahtarı belirlemeniz gerekir. Bu, anahtarı #{api_key} yer tutucusuyla bir istek URL'sinde kullanmanıza olanak tanır.

Bunu yapmak için, istediğiniz API anahtarının sağındaki "{+}" düğmesine tıklayın:

Ardından, anahtarın yanında, bunun birincil proje anahtarı olduğunu belirten bir etiket görünecektir.

Birincil proje anahtarına api_key aracılığıyla erişebilirsiniz: gerekli anahtarı oluşturun, izinlerini ayarlayın ve birincil proje anahtarı olarak belirleyin. Ardından, Hesap Makinesi'nde, birincil proje anahtarının değerini içerecek olan #{api_key} yer tutucusuyla istek URL'sini kullanın.

Erişim ayarlarıyla oluşturulan diğer tüm anahtarlar ikincil anahtarlar olarak kabul edilecektir. İstek URL'sinde, #{api_key} yerine bunların değerini kullanabilirsiniz. Bunu yapmak için, ikincil anahtarın değerini kopyalayın:

ve #{api_key} yerine istek URL'sine yapıştırın:

Eski yöntemle oluşturulan bir API anahtarı varsayılan olarak birincil proje anahtarı olarak ayarlanır ve tam izinlere sahiptir.

Not!

Birincil proje anahtarı olarak ayarlanan anahtarı silerseniz, yeni bir anahtarı manuel olarak birincil olarak belirlemeniz gerekecektir.

Lütfen dikkat!

Eski yöntemle oluşturulmuş API anahtarlarınız varsa, normal şekilde çalışmaya devam edeceklerdir. Eski türde yeni API anahtarları oluşturmak mümkün değildir.

Proje ayarlarında belirtilen Webhook URL'sinde mesajlar nasıl alınır

Proje ayarları

Her gelen veya giden mesaj, aşağıdaki JSON POST isteği olarak gönderilecektir:

{
    "id": "sistemdeki mesaj kimliği",
    "client": {
        "id": "sistemdeki müşteri kimliği",
        "recepient": "mesajlaşma uygulamasındaki müşteri kimliği",
        "client_type": "mesajlaşma uygulaması türü",
        "name": "müşteri adı",
        "avatar": "müşteri avatarı",
        "created_at": "müşteri oluşturma tarihi",
        "tag": "abonelik anahtarı",
        "group": "müşterinin bağlı olduğu bot"
    },
    "message": "mesaj metni",
    "attachments": "dosya bağlantılarını veya dosya bağlantıları sözlüklerini içeren dizi",
    "message_id": "mesajın gönderildiği bloğun kimliği",
    "project_id": "proje kimliği",
    "is_input": "mesaj müşteriden ise 1, bottan ise 0",
    "delivered": "mesaj başarıyla gönderildiyse 1, hata varsa 0",
    "error_message": "mesaj gönderme hatasının metni"
}

Bir istek hata döndürürse, yeniden denenmez. Sunucu hatalar döndürse bile bildirimler gönderilmeye devam edecektir.

JSON isteği nasıl oluşturulur

Verilerin tabloya kaydedileceği bloğun ayarlarına gidin.

Bir API İsteği bölümü ekleyin.
İstek türü olarak POST-JSON'u seçin.
Ardından istek alanlarını doldurmaya devam edin:

İstek URL'si — çağrılacak işlevin yolu. Belgelerde bu, her zaman istek türünün yanındaki ilk satırda gösterilir:

Kaydedilen değerler — sonuçların saklanması gereken değişken adlarıyla birlikte yanıt parametrelerinin bir listesi, aşağıdaki formatta:

request_parameter -> your_variable

Yanıt karmaşık yapıya sahip parametreler içeriyorsa, bunları aşağıdaki gibi ayrıştırın:

"cell_number":{"row":4,"col":2}\n> > \n> > \n> > cell_number|row ->String; \n> > cell_number|col -> Sütun

İstek başlıkları — gerekirse doldurun. Bu genellikle veri formatını ve/veya erişim belirtecini içerir.

JSON parametreleri — istek gövdesi, veri parametrelerini JSON formatında belirttiğiniz yer. Örnek:

{"client_id": "#{recipient_id_in_builder}", "message":"Merhaba!"}

Yanıtın yapısını anlamak için, değişkenin değerini çıkarmak üzere Mesaj alanına #{custom_answer} yazın.

Ardından, belgeler "Gövde" bölümünde izin verilen parametreleri listeler:

Evrensel webhook nasıl kullanılır

Listelenen yöntemler artık POST veya GET istekleri olarak yürütülebilir.

callback
whatsapp_callback
message
whatsapp_message

Daha önce, yöntemlerimiz abone eylemlerini tetiklemek için sabit parametrelere (örneğin client_id ve fb_id) sahipti ve bu, üçüncü taraf hizmetlerle entegrasyon sırasında belirli sınırlamalar getiriyordu.

Artık MaviBot'un kullanıcı kimliğini bulmak için hangi istek parametresini kullanması gerektiğini belirtebilirsiniz. value_ prefix önekine sahip bir parametre kullanın, örneğin value_user_id veya value_group_id.

Ayrıca, geri arama gönderme yöntemi artık müşterinin e-postası (client_email) veya telefon numarası (client_phone) kullanılarak da tetiklenebilir.

callback, fb_callback ve whatsapp_callback yöntemleri belirli parametre adlarına bağlı değildir. Müşterinin telefon numarasını, e-postasını veya kimliğini hangi parametrenin içerdiğini belirtebilirsiniz.

Bu, bir web sitesinden webhook alımı ayarlarken kullanışlıdır.

Hangi değişkenin client_id içerdiğini belirtmek için, value_client_id parametresini kullanın ve bu değeri tutan parametrenin adını sağlayın.

Hangi değişkenin telefon numarasını içerdiğini belirtmek için, value_phone kullanın.

Hangi değişkenin e-postayı içerdiğini belirtmek için, value_email kullanın.

Hangi değişkenin user_id içerdiğini belirtmek için, value_user_id kullanın.

Hangi değişkenin group_id içerdiğini belirtmek için, value_group_id kullanın.

Webhook'taki mesajın kendisini içeren değişkeni belirtmek için, value_message kullanın (diğer parametrelerle aynı şekilde iletilir).

Örnek:

Adreste, value_client_id = my_client belirtin.

https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback?value_client_id=my_client
{"my_client":49177759, "message":"Merhaba dünya"}

İstek, aşağıdakine eşdeğer olacaktır:

https://chatter.mavibot.pro/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback
{"client_id":49177759, "message":"Merhaba dünya"}

Gördüğünüz gibi, değeri içeren parametre adına value_ öneki eklenmiştir.

Lütfen dikkat!

Bazı olaylar proje içinde sistem bildirimleri oluşturur.

Örneğin, boş olmayan ancak müşteri metni içermeyen bir mesaj alanına sahip sistem bildirimleri vardır.

Aynı zamanda, proje "message: new_chat_member" gibi belirli içeriğe sahip mesaj kancaları da oluşturabilir.

Bu nedenle, içeriği kontrol etmek önemlidir: bu ya bir sistem bildirimi ya da belirli bir olay için bir kanca olacaktır.

Bot nasıl başlatılır

Botu başlat

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/callback

Bu yöntem, bir müşteri için bir huni tetiklemek veya harici bir kaynakta bir eylemi onaylamak için kullanılabilir. Müşteri bu mesajı görmeyecektir.

Lütfen dikkat: ek olarak ilettiğiniz herhangi bir parametre değişkene kaydedilecektir

Geri arama yöntemi artık müşterinin e-postası (client_email) veya telefon numarası (client_phone) kullanılarak da tetiklenebilir.

Anahtar oluştururken erişim izni: "Müşteri bilgilerini değiştirme/silme izni".

Yol

api key* - erişim belirteci

Gövde

client_phone - müşteriyi bulmak için kullanılan telefon numarası

client_email - müşteriyi bulmak için kullanılan e-posta

client_id - yapıcıdaki müşteri kimliği

message - mesaj metni

resume_bot - True (isteğe bağlı parametre). Bot duraklatılmışsa, devam ettirmek için kullanılır.

Örnek: resume_bot = True

time_shift - sayı. Belirtilirse, mesaj geçerli saatten itibaren verilen saniye sayısı kadar sonra gönderilecektir.

send_time - "%Y-%m-%d %H:%M:%S" formatında tarih ve saat (ör. "2024-10-16 13:15:59"). Bu, mesajın gönderilmesi için tarih ve saati ayarlar. Hem time_shift hem de send_time belirtilirse, time_shift öncelikli olacaktır.

import requests
import json

params = {"message": "some_text", "client_id": "25554"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.salebot.pro/api/{token}/callback'
requests.post(url, json=params)

Bir WhatsApp numarası kullanarak botu başlatma

URL isteği: https://chatter.mavibot.ai/api/\<api_key>/whatsapp_callback>

Bu yöntem, bir müşteri web sitesine kaydolduktan veya telefon numarasıyla bir talep gönderdikten sonra WhatsApp botunu tetikleyebilir.

Lütfen dikkat: ek olarak ilettiğiniz herhangi bir parametre değişkende kaydedilecektir

Anahtar oluştururken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".

Yol

api key* - erişim belirteci

Gövde

name - müşteri adı
message - mesaj metni
phone - müşteri telefon numarası
bot_id - bot kimliği
resume_bot - True (isteğe bağlı parametre). Bot duraklatılmışsa, devam ettirmek için bunu kullanın. Örnek: resume_bot = True

time_shift - sayı. Belirtilirse, mesaj geçerli saatten itibaren verilen saniye sayısı kadar sonra gönderilecektir.

send_time - "%Y-%m-%d %H:%M:%S" biçiminde tarih ve saat (örneğin, "2024-10-16 13:15:59"). Bu, mesajın gönderilmesi için tarih ve saati ayarlar. Hem time_shift hem de send_time belirtilmişse, time_shift öncelikli olacaktır.

Telegram kimliği kullanarak botu başlatma

URL isteği: https://chatter.mavibot.pro/api/#{api\_key}/tg\_callback

Bu yöntem, bir müşteri için bir huni tetiklemek veya harici bir web sitesinde bir eylemi onaylamak için kullanılabilir. Müşteri bu mesajı görmeyecektir.

Lütfen dikkat: ek olarak ilettiğiniz herhangi bir parametre değişkenlerde kaydedilecektir.

Anahtar oluştururken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".

Yol

api key* - erişim belirteci

Gövde

message - mesaj metni
user_id - Telegram kullanıcı kimliği
group_id - bot adı (bot ile biter)
resume_bot - True (isteğe bağlı parametre). Bot duraklatılmışsa, devam ettirmek için bunu kullanın. Örnek: resume_bot = True

time_shift - sayı. Belirtilirse, mesaj geçerli saatten itibaren verilen saniye sayısı kadar sonra gönderilecektir.

platform_id'ye göre bir müşteri listesine geri arama mesajları gönderme

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/send\_callback\_by\_platform\_id

Listeden platform_id'ye sahip müşteriler projede bulunduğunda, callback_text alanındaki metinle bir geri arama gönderilecektir.
\ Sınır: 1 istek = maksimum 300 gönderim

İstek parametreleri örneği:
{"platform_ids":[407184121, "79609879898", "2rwewefw"], "callback_text": "test_callback"}

Anahtar oluştururken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".

Yol

api key* - erişim belirteci

Gövde

platform_ids - Mesajlaşma uygulamasındaki müşteri kimliklerinin listesi
callback_text - geri arama metni
group_id - bot kimliği

time_shift - sayı. Belirtilirse, mesaj geçerli saatten itibaren verilen saniye sayısı kadar sonra gönderilecektir.

E-posta ile bir müşteriye geri arama mesajı gönderme

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/email\_callback

Bu yöntem, bir müşteri web sitesine kaydolduktan veya e-postasıyla bir talep gönderdikten sonra e-posta botunu tetikleyebilir. Yöntem, müşterinin e-postasını bulacak veya bulunamazsa oluşturacaktır.

Anahtar oluştururken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".

Lütfen dikkat: ek olarak ilettiğiniz herhangi bir parametre değişkende kaydedilecektir

Yol

api key* - erişim belirteci

Gövde

name - müşteri adı
message - mesaj metni
email - e-posta adresi
email_id_bot - bot e-posta adresi
resume_bot - True (isteğe bağlı parametre).

Bot duraklatılmışsa, devam ettirmek için bunu kullanın. Örnek: resume_bot = True

time_shift - sayı. Belirtilirse, mesaj geçerli saatten itibaren verilen saniye sayısı kadar sonra gönderilecektir.

Mesajlarla nasıl çalışılır

Mesaj gönderme parametreleri

attachment_type — şunlar olabilir: image, video, link, file veya audio.
Bir ek gönderirken, mesaj parametresi isteğe bağlıdır.

buttons — mesaja eklenecek düğmeleri tanımlar. Düğme biçimi, gelişmiş düğme ayarlarıyla eşleşir.

Düğmeler iki şekilde iletilebilir: düğmeleri desteklemeyen mesajlaşma uygulamaları için bir ipucu ile veya ipucu olmadan.

buttons parametresi örneği:

"buttons": {
  "hint": "Bu metin WhatsApp'ta görüntülenecek",
  "buttons": [
    {
      "type": "reply",
      "text": "Hizmetler hakkında bilgi ver",
      "line": 0,
      "index_in_line": 0
    },
    {
      "type": "reply",
      "text": "Hizmet fiyatları",
      "line": 0,
      "index_in_line": 1
    },
    {
      "type": "reply",
      "text": "İletişim",
      "line": 1,
      "index_in_line": 0
    },
    {
      "type": "reply",
      "text": "Talep gönder",
      "line": 1,
      "index_in_line": 1
    }
  ]
}

Bir müşteriye mesaj gönderme

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/message

Bu yöntem, bildirim mesajları göndermek için kullanılabilir. Bir dosya göndermiyorsanız mesaj parametresi gereklidir. Bir dosya gönderiyorsanız, metin isteğe bağlıdır.

Anahtar oluştururken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".

Yol

api key* - erişim belirteci

Gövde

message_id - gönderme için blok numarası
message - mesaj metni
client_id - oluşturucudaki müşteri kimliği
attachment_type - dosya görüntüleme türü. attachment_url sağlanmışsa gereklidir.
attachment_url - dosya URL'si
buttons - düğmeler

time_shift - sayı. Belirtilirse, mesaj geçerli saatten itibaren verilen saniye sayısı kadar sonra gönderilecektir.

import requests
import json

# Metin mesajı gönderme
params = {"message": "some_text", "client_id": "25554"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/message'
requests.post(url, json=params)

# Ek gönderme
params = {
    "message": "some message",
    "client_id": "1234565",
    "attachment_type": "video/image/file",
    "attachment_url": "https://qwreqw"
}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/message'
requests.post(url, json=params)

# 'attachment_type' içinde, ek türüne bağlı olarak 'video', 'image' veya 'file' belirtin:
# video, resim veya belge.

WhatsApp'ta mesaj gönderme

URL isteği: https://chatter.mavibot.pro/api/\<api_key>/whatsapp_message>

Bağlı bot adına belirtilen numaraya bir mesaj göndermenizi sağlar. whatsapp_bot_id, "Mesajlaşma uygulamaları ve sohbetler" bölümünden alınmalıdır. Bağlı her WhatsApp hesabına oluşturucu tarafından benzersiz bir tanımlayıcı atanır.

Anahtar oluştururken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".

Yol

api key* - erişim belirteci

Gövde

message_id - gönderme için blok numarası
whatsapp_bot_id - mesajın gönderileceği WhatsApp bot kimliği
attachment_url - dosya URL'si
attachment_type - dosya görüntüleme türü. attachment_url sağlanmışsa gereklidir.
message - mesaj metni
phone - alıcı telefon numarası

time_shift - sayı. Belirtilirse, mesaj geçerli saatten itibaren verilen saniye sayısı kadar sonra gönderilecektir.

import requests
import json

params = {"message": "some_text", "phone": "79875146788"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/whatsapp_message'
requests.post(url, json=params)

Toplu mesaj gönderme

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/broadcast

Bu yöntem, bir yayın başlatmanıza olanak tanır.

Aşağıdaki birbirini dışlayan seçeneklerden birini kullanabilirsiniz:

list parametresi — yayın belirtilen müşteri listesine gönderilecektir.
clients parametresi — yayın bir müşteri kimliği dizisine gönderilecektir.
platform_ids ve group_id parametreleri — yayın, belirtilen bot (group_id) için bir platform_ids (mesajlaşma uygulaması kimlikleri) dizisine gönderilecektir.
Yukarıdaki parametrelerden hiçbiri sağlanmazsa, yayın gönderilmeyecektir.

Gerekli parametreler: message (ve/veya attachment_type ve attachment_url) veya message_id.

Anahtar oluştururken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".

Yol

api key* - erişim belirteci

Gövde

list - yayının gönderileceği liste numarası

clients - oluşturucudaki müşteri kimlikleri

message - mesaj metni

platform_ids - mesajlaşma uygulamasındaki alıcı kimlikleri. Gerekli group_id parametresiyle birlikte kullanılmalıdır

group_id - yalnızca platform_ids kullanılırken gereklidir. Diğer seçeneklerle yok sayılır. Verilen platform_ids'ye gönderme için botu belirtir

attachment_url - dosya URL'si

attachment_type - dosya görüntüleme türü. attachment_url sağlanmışsa gereklidir.

buttons - düğmeler

message_id - gönderme için blok numarası

shift — mesajlar arasındaki saniye sayısı. Varsayılan 0,2'dir.

time_shift - sayı. Belirtilirse, mesaj geçerli saatten itibaren verilen saniye sayısı kadar sonra gönderilecektir.

import requests
import json

params = {"message": "some_text", "clients": ["5", "58", "110"]}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/broadcast'
requests.post(url, json=params)

Mesaj geçmişini alma

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/get\_history?client\_id=

client_id parametresi buradan alınabilir. link

Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini okuma izni".

Path

api key* - erişim token'ı

Body

client_id - müşteri ID'si

limit - yanıttaki öğe sayısı. Varsayılan: 2000, maksimum: 2000

start_date - seçim döneminin başlangıç tarihi (stop_date belirtilmişse zorunlu), biçim: gg.aa.yyyy

stop_date - seçim döneminin bitiş tarihi (start_date belirtilmişse zorunlu), biçim: gg.aa.yyyy

{
  "status": "success",
  "result": [
    {
      "id": 104500,
      "answered": true,
      "client_replica": false,
      "message_id": 390,
      "message_from_outside": 0,
      "created_at": 1587895014,
      "text": "Meow meow",
      "attachments": {
        
      },
      "delivered": true,
      "error_message": "true",
      "manager_id": 12486,
      "manager_email": "[email protected]"
    },
  ]
}

Mesaj geçmişini temizle

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/clear\_history?client\_id=

Sohbet geçmişini siler

Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme/silme izni".

Path

api key* - erişim token'ı

Body

client_id - müşteri ID'si

import requests
import json


token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/clear_history?client_id=85856'
requests.get(url)

Müşteriler nasıl atanır

Bir müşteriyi bir çalışana atama

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/assign\_to\_user

Bu yöntem, bir müşteriyi bir çalışana atamanıza olanak tanır. email parametresi isteğe bağlıdır. E-posta sağlanmazsa, sistem müşteriyi kendi algoritmasına göre atar.

Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme/silme izni".

Path

api key* - erişim token'ı

Body

client_id - müşteri ID'si
email - çalışan e-postası (isteğe bağlı)

import requests
import json

params = {"client_id":"#{client_id}","email":"[email protected]"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/broadcast'
requests.post(url, json=params)

Müşterileri sisteme aktarma

URL isteği: https://chatter.mavibot.pro/api/#{api\_key}/load\_clients

Bu yöntem, müşterileri sisteme aktarmanıza olanak tanır. WhatsApp müşterileri yüklenirken, numarayı @s.whatsapp.net son ekiyle veya bu ek olmadan herhangi bir biçimde sağlayabilirsiniz.

Grup kimliği (group_id), /api/<api_key>/connected_channels aracılığıyla BURADAN alınabilir. (client_type = 13 (telefon) ise, group_id boş bir dizedir: ""). link

Müşterinin geldiği mesajlaşma türü (client_type) BURADA bulunabilir. link

Örnek: [{"platform_id":"79875555555","group_id":34810,"client_type":6}]

Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".

Path

api key* - erişim token'ı

Body

platform_id - telefon numarası
group_id - grup ID'si
client_type - müşterinin geldiği mesajlaşma türü

import requests
import json
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/load_clients'
params = [{ "platform_id": 274827917, "group_id": 169166236, "client_type":0},
{"platform_id":"[email protected]", "group_id": "1hwF7lwEjv4SKYIGFhQnBw==", "client_type": 6}]
requests.post(url, json=params)
# başarılı olursa, işlev her öğe için bir ID ve ekleme durumu döndürür
# yanıt örneği
# {"status":"success","items":[{"platform_id":"[email protected]","group_id":"5kqchxwyvdvFZOsp80q2qw==","client_type":6,"status":"success","id":1469409}]}

Müşterileri bir listeye ekleme

URL isteği: https://chatter.mavibot.ai/api/\<api_key>/add_to_list

Müşterileri bir listeye ekler

Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".

Path

api key* - erişim token'ı

Body

list_id - liste numarası
clients - müşteri ID dizisi

Örnek:
JSON parametreleri
{"list_id":1170282, "clients":[411262772, 646410963]}

Müşterileri bir listeden çıkarma

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/remove\_from\_list

Müşterileri bir listeden çıkarır

Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".

Path

api key* - erişim token'ı

Body

list_id - liste numarası
clients - Mavibot builder'daki müşteri numaraları dizisi (client_id değerleri)

Müşteri listesini alma

URL isteği: https://chatter.mavibot.a/aipi/\<api_key>/get_clients

Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".

Path

api key* - erişim token'ı

Body

offset – İlk öğeden itibaren kaydırma

limit – Yanıttaki öğe sayısı / Varsayılan: 500, Maksimum: 500

list – Liste numarası

reverse – Ters sıralamayı belirtir (en eski kayıttan en yeniye). Bu parametre yalnızca liste belirtilmediğinde çalışır.

Durumu ve bir öğe dizisini döndürür.

{
"status":"success",
"clients":[{
    "id":44483,
    "platform_id":"146467928",
    "client_type":0,
    "name":null,
    "avatar":null,
    "message_id":null,
    "project_id":1,
    "created_at":1588248599,
    "updated_at":1588248599,
    "custom_answer":null,
    "tag":null,
    "group":"143414131",
    "operator_start_dialog":null
    }
]
}

Herhangi bir mesajlaşma uygulamasındaki bot abonelerinin listesini alma

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/subscribers

Seçilen bir mesajlaşma uygulamasından müşteri bilgilerini alır.

Not! Bu yöntem değişkenleri döndürmez.

Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".

Path

api key* - erişim token'ı

Body

page
tag – Abonelik sayfasında belirtilen etiket
group – Abonenin bağlı olduğu VK grup ID'si
date_from – Bu tarihten sonra abone olanlar (zaman damgası)
date_to – Bu tarihten önce abone olanlar (zaman damgası)
client_type – Abone listesinin alınacağı mesajlaşma uygulaması ID'si. Belirtilmezse tüm müşteriler döndürülür

[  
  {
    "id": 44886,
    "tag": null,
    "created_at": 1609867984,
    "name": "John Smith",
    "vk_id": "146467928",
    "group": "155824294",
    "variables": null
  },
  {
    "id": 44889,
    "tag": null,
    "created_at": 1609867984,
    "name": "Anna Smith",
    "vk_id": "1609867984",
    "group": "155824294",
    "variables": {
      "utm_source": "some_value"
    }
  }
]

Değişkenlerle nasıl çalışılır

Değişken atama

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/save\_variables

!** **Bu istek için herhangi bir sınırlama geçerli değildir.

Değişkenleri hem potansiyel müşteriye hem de müşteriye kaydetmenize olanak tanır.
Varsayılan olarak, değişken atama isteği bunları fırsat değişkenlerine ekler.
Müşteri profilindeki değişkenleri güncellemek için client. önekini kullanın. Örneğin, telefon için: client.phone.

Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".

Güncelleme: clients parametresi, değişkenleri toplu olarak atamaya olanak tanır.
Örnek: {"client_id":49177759, "variables":{"client.phone":"88888888888"}}

Path

api key* - erişim token'ı

Body

clients – Değişken ataması için müşteri ID'leri dizisi

client_id – Müşteri ID'si

variables – Değişkenlerin karması (anahtar-değer çiftleri)

import requests
import json

params = {"client_id": "25554", "variables": {"var_name": "var_value"}}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/save_variables'
requests.post(url, json=params)

Değişkenleri alma

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/get\_variables?client\_id=

Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".

Örnek: https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/get\_variables?client\_id=49177759

Path

api key* - erişim token'ı

Body

client_id - müşteri ID'si

import requests
import json


token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/get_variables?client_id=85856'
requests.get(url)

Müşteri ID'si (client_id) nasıl alınır

platform_id değerini kullanarak client_id alma

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/find\_client\_id\_by\_platform\_id

Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".

Path

api key* - erişim token'ı

Body

platform_ids - Bir mesajlaşma uygulamasındaki ID'lerin dizisi
group_id - bot ID'si

[{
"id":15099119,
"tag":null,
"created_at":1618815253,
"name":"ОЛЬГА БЕЛИК",
"avatar":"https:\\/\\/files.mavibot.ai\\/uploads\\/avatars\\/256865200.jpg",
"platform_id":"2568652",
"group":"Mavibotai_bot",
"variables":{"tg_username":"@belik"}},

{"id":21087377,
"tag":null,
"created_at":1626275893,
"name":"John Smith",
"avatar":"https:\\/\\/files.mavibot.ai\\/uploads\\/avatars\\/571830542.jpg",
"platform_id":"571830542",
"group":"Mavibotai_bot",
"variables":{"tg_username":"@jsmith61"}
}]

Müşteri ID'sini çevrimiçi sohbetten alma

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/online\_chat\_client\_id?recipient=

Bu yöntem, bir web sitesini sohbet botuyla entegre etmenize olanak tanır. Örneğin, bir kullanıcı bir promosyon sayfasını ziyaret ederse, sohbette kişiselleştirilmiş bir teklifle hemen bir mesaj gönderebilirsiniz.

Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".

Yol

api key* - erişim token'ı

Gövde

tag - etiket (istemci etiketi)\nname - istemci adı\nrecipient - web sitesindeki diyalog kimliği

recipient nereden alınır?

Mavibot.ai çevrimiçi sohbeti olan web sitesinde, MavibotAi.recipient_id özelliğini almak için JS kullanabilirsiniz.

{ "client_id": 36553 }

WhatsApp numarasına göre client_id alma

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/whatsapp\_client\_id?phone=

Bu yöntem, istemcinin WhatsApp telefon numarasını biliyorsanız API istekleri yapmak için istemci kimliğini döndürür.
Bu numaraya sahip bir istemci yoksa, yöntem 404 hatası döndürür.

Anahtar oluştururken erişim izni: "İstemci bilgilerini değiştirme veya silme izni".

Yol

api key* - erişim token'ı

Gövde

phone - telefon numarası\ngroup_id - bot kimliği

Telefon numarasına göre client_id alma

URL isteği: https://chatter.mavibot.ai/api/\<api_key>/find_client_id_by_phone?phone=

Bu yöntem, API istekleri yapmak için istemci kimliğini döndürür.

Arama hem WhatsApp istemcileri arasında hem de değişkenler aracılığıyla yapılır.

Anahtar oluştururken erişim izni: "İstemci bilgilerini değiştirme veya silme izni".

Yol

api key* - erişim token'ı

Gövde

phone - telefon numarası

E-postaya göre client_id alma

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/find\_client\_id\_by\_email?email= 

Bu yöntem, API istekleri yapmak için istemci kimliğini döndürür.
Arama değişkenler kullanılarak yapılır.

Anahtar oluştururken erişim izni: "İstemci bilgilerini değiştirme veya silme izni".

Yol

api key* - erişim token'ı

Gövde

email - arama için e-posta

Değişken değerine göre client_id alma

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/find\_client\_id\_by\_var?var=\&val=

Bu yöntem, API istekleri yapmak için istemci kimliğini döndürür.

Anahtar oluştururken erişim izni: "İstemci bilgilerini okuma izni"

Yol

api key* - erişim token'ı

Gövde

var - aranacak değişken adı\nval - değişken değeri\ngroup_id - grup kimliği\nsearch_in - anlaşma değişkenlerinde arama yapmak için 'order' değerini geçirin; proje istemcileri için en fazla üç değişkeni arar ve belirtilen tüm değişkenlere sahip istemcilerin bir listesini döndürür.

Değişken değerine göre en son oluşturulan istemcinin kimliğini alma

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/find\_latest\_client\_id\_by\_var ?var=&val=

Bu yöntem, API istekleri yapmak için en son oluşturulan istemcinin kimliğini döndürür. Hem istemci hem de anlaşma değişkenlerini arar.

Anahtar oluştururken erişim izni: "İstemci bilgilerini okuma izni"

Yol

api key* - erişim token'ı

Gövde

var - aranacak değişken adı\nval - değişken değeri

Değişken değerine göre client_id değerlerinin listesini alma

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/find\_all\_client\_id\_by\_var?var=\&val=

Bu yöntem, belirtilen değişkene sahip olan ve belirtilen değere sahip istemci kimliklerinin bir listesini döndürür.

Anahtar oluştururken erişim izni: "İstemci bilgilerini okuma izni"

Yol

api key* - erişim token'ı

Gövde

var - aranacak değişken adı\nval - değişken değeri

{
    // Yanıt
}

Birden çok değişken değerine göre client_id değerlerinin listesini alma

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/find\_all\_client\_id\_by\_several\_vars?var=val

Anahtar oluştururken erişim izni: "İstemci bilgilerini okuma izni".

Yol

api key* - erişim token'ı

Gövde

değişken1 - Değer1

değişken2 - Değer2

değişken3 - Değer3

{
 "status":"success","client_ids":[93891114]
}

Değişkenlere göre arama

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/find\_clients

Bu yöntem değişkenlere göre arama yapar ve sorgu koşullarını karşılayan istemci kimliklerinin bir listesini döndürür.

Varsayılan olarak, arama istemci değişkenleri üzerinde yapılır (önerilir): {"q": {"result": "ok", "var": "home", "var": "60"}} – istemci belirtilen tüm değişkenlere sahip olmalıdır

Anlaşma değişkenlerinde arama, belirtilen değişkenlerden en az biri mevcut olmalıdır: {"q": {"result": "ok", "var": "home", "var": "60"}, "search_in": "order", "include_all": False}

İstemci değişken adı liste değerlerinden birine eşittir: {"q": {"name": {"_in": ["Joe", "Jane", "Donald"]}}}

İstemci değişken adı liste değerlerinden herhangi birine eşit DEĞİLDİR: {"q": {"name": {"_not_in": ["Joe", "Jane", "Donald"]}}}

İstemci değişken adı "Joe"ya eşit değildir: {"q": {"name": {"_not": "Joe"}}}

Not: Sayı karşılaştırması yalnızca tüm istemcilerin aranan değişkende sayısal değerleri varsa çalışır. En az bir istemcinin bir dizesi varsa, istek başarısız olur.

Anahtar oluştururken erişim izni: "İstemci bilgilerini okuma izni"

Parametreler

Yol

api key* - erişim token'ı

Gövde

q – gerekli parametre, değişkenleri aramak için sorgu koşullarını içerir

search_in – hangi varlığın değişkenlerinin aranacağını belirtir; sağlanmazsa, arama istemci değişkenleri üzerinde yapılır. order değerini alabilir.

include_all – q'daki tüm koşulların karşılanması gerekip gerekmediği;

False – en az bir koşul eşleşirse varlık seçilir

Başarılı
{"status":"success","client_ids":[41203, 5622354, 785212]} 
{"status":"success","client_ids":[]} 
{"status": "fail", "message": "Parameter "q" required"} {"status": "fail", "message": "Error in parameter format"}
Hata
{"status":"fail","message":"Something went wrong"}

Anlaşmalarla nasıl çalışılır

Geçerli anlaşma kimliğini alma

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/get\_current\_order\_id

Anahtar oluştururken erişim izni: "CRM bilgilerini okuma izni".

Yol

api key* - erişim token'ı

Gövde

client_id - istemci kimliği

Başarılı yanıt: {"status":"success","order_id":40632}, burada
order_id - geçerli anlaşma kimliği
Hata yanıtı: {"status":"client_not_found"}

Anlaşma listesini alma

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/get\_orders

Anahtar oluştururken erişim izni: "CRM bilgilerini okuma izni"

Yol

api key* - erişim token'ı

Gövde

client_id - istemci kimliği

order_status - anlaşma aşaması:
0 - aktif anlaşmalar
1 - başarılı anlaşmalar
2 - başarısız anlaşmalar

Başarılı yanıt: {"status":"success","order_id":[40338,40340,40341]} 
Hata yanıtı: {"status":"client_not_found"}

Bir anlaşmayı Mavibot hunisinde bir sonraki aşamaya taşıma

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/move\_order\_to\_next\_state

Anahtar oluştururken erişim izni: "CRM bilgilerini değiştirme/silme izni"

Yol

api key* - erişim token'ı

Gövde

client_id - istemci kimliği

order_id - anlaşma kimliği

Başarılı yanıt: 
{"status":"success","state_id":37}, burada 
state_id - MavibotCRM'deki aşama kimliği 
Hata yanıtı: 
{"status":"client_not_found"}

Anlaşma verilerini alma

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/get\_order\_vars

Anahtar oluştururken erişim izni: "CRM bilgilerini okuma izni"

Yol

api key* - erişim token'ı

Gövde

client_id - istemci kimliği

order_id - anlaşma kimliği

değişkenler - değişken dizisi
(biçim:["var_name1", "var_name2"])

Başarılı yanıt: 
{"status":"success","result":{"var_name1":"111","var_name2":"13.04.2023"}} 

Hata örneği: 
{"status":"client_not_found"}

Anlaşma değişkenleri ekleme

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/set\_order\_vars

Anahtar oluştururken erişim izni: "CRM bilgilerini değiştirme/silme izni"

Yol

api key* - erişim token'ı

Gövde

client_id - istemci kimliği

order_id - anlaşma kimliği

değişkenler - Değişkenler sözlüğü (anahtar değişken adıdır ve değer, bu değişkene kaydedilmesi gereken şeydir)
(biçim:{"var_name": "var_value"})

Başarılı yanıt: {"status":"success"} 
Hata yanıtı: {"status":"order 12345 not found"}

Anlaşma oluşturma

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/create\_order

Anahtar oluştururken erişim izni: "CRM bilgilerini değiştirme/silme izni"

Yol

api key* - erişim token'ı

Gövde

client_id - istemci kimliği

name - anlaşma adı

description - anlaşma açıklaması

budget - anlaşma tutarı

İstekte aşağıdaki parametrelerden birini belirtmelisiniz: client_id, email veya phone.
Birden çok parametre sağlanırsa, yalnızca biri kullanılır. Öncelik sırası şöyledir: client_id > phone > email.
phone veya email sağlanırsa ve bu telefon numarasına veya e-postaya sahip bir istemci yoksa, yeni bir istemci oluşturulur.

Başarılı yanıt: {"status":"success","order_id":40654}, 
burada order_id yeni aktif anlaşmanın kimliğidir.
Hata yanıtı: {"status":"client_not_found"}

MavibotCRM'de bir anlaşmayı aşamaya taşıma

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/set\_order\_state

Anahtar oluşturulurken erişim izni: "CRM bilgilerini değiştirme/silme izni"

Yol

api key* - erişim token'ı

Gövde

client_id - müşteri kimliği

state_id - müşterinin anlaşmasının taşınması gereken aşama numarası

Mavibot CRM'de huni aşama kimliğini alma

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/get\_order\_state

Anahtar oluşturulurken erişim izni: "CRM bilgilerini okuma izni"

Yol

api key* - erişim token'ı

Gövde

client_id - müşteri kimliği

state_id - anlaşma kimliği (belirtilmezse, yöntem mevcut anlaşmanın aşama kimliğini döndürür)

Başarılı yanıt örneği:
{'status': 'success', 'state_id': 123456}

Başarısız yanıt örneği:
{'status': 'order not found'}

Başka hangi yetenekler mevcut?

Bir telefon numarasının WhatsApp'ı olup olmadığını kontrol etme

URL isteği: https://chatter.mavibot.ai/api/#{api\_key}/check\_whatsapp

Bu yöntemi kullanmak için WhatsApp'ın Mavibot'a bağlı olması gerekir.

Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".

GET veya POST kullanılarak çağrılabilir.
Telefon numarası herhangi bir formatta sağlanabilir.

Yol

api key* - erişim token'ı

Gövde

phone - kontrol edilecek telefon numarası

Projeye bağlı mesajlaşma uygulamalarının listesini alma

URL isteği: https://chatter.mavibot.ai/api/\<api_key>/connected_channels

Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".

Fonksiyon, müşteri içe aktarılırken kullanılması gereken her mesajlaşma uygulaması için group_id parametresini döndürür.

WhatsApp için ayrıca aşağıdaki değerlere sahip olabilen bir status alanı döndürür:

NOT_STARTED = 0
STARTED = 1
ASLEEP = 2
STOPPED = 3

Yol

api key* - erişim token'ı

{'project_id': 1, 
'viber': [{
        'id': 14, 
        'uri': 'mavibotstage', 
        'name': 'mavibotstage', 
        'enabled': true,
        'group_id': 11}], 
'facebook': [], 
'telegram': [{
        'id': 23, 
        'short_name': 'bulls_vs_bears_bot', 
        'name': 'bulls_vs_bears_bot', 
        'enabled': true,
        'group_id': 'bulls_vs_bears_bot'}], 
'whatsapp': [], 
'avito': [], 
'ok': [], 
'vkontakte': [{
        'id': 33, 
        'group': '143414131',
        'group_id': '143414131'}]
}

Bot akışından blok listesini alma

URL isteği: https://chatter.mavibot.ai/api/\<api_key>/get_messages

Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".

Yol

api key* - erişim token'ı

İç içe geçmiş müşteri verilerini alma

İç içe geçmiş sözlüklerden (birinci seviyede olmayan) client_id ve/veya müşterinin telefon numarasını almak için ayırıcı parametresini kullanın.

İstek URL'nize aşağıdakini ekleyin:

?delimiter=1&delimiter_value_client_id={key1}1{key2}&delimiter_value_phone={key1}1{key2}

burada:

?delimiter=1 – anahtarları ayıran ayırıcı değeri {key1}1{key2}1{key3}

delimiter_value_client_id={key1}1{key2} – müşteri kimliğini almak için

delimiter_value_phone={key1}1{key2} – müşteri telefon numarasını almak için

{key1}, {key2}, … – değerleri içeren anahtarlar (ayırıcı dışında herhangi bir karakter içerebilir). Sınırsız sayıda anahtarınız olabilir:
?delimiter=1&delimiter_value_client_id={key1}1{key2}1{key3}1{key4}1{key5}1{key6}.
Anahtarlar süslü parantez olmadan iletilir.

Anahtarlar arasında ayırıcıyı kullanın. Örneğin, delimiter=2 ise {key1}2{key2}2{key3}; delimiter=5 ise {key1}5{key2}5{key3}. Anahtarın ayırıcı karakterini içermediğinden emin olun.

Örnek:

https://chatter.mavibot.a/aipi/\<api_key>/callback****?delimiter=1&delimiter_value_client_id={key1}1{key2}&delimiter_value_phone={key1}1{key2}****

Yalnızca kimliği veya yalnızca telefon numarasını da alabilirsiniz:

https://chatter.salebot.pro/api/\<api_key>/callback****?delimiter=1&delimiter_value_client_id={key1}1{key2} -**** yalnızca müşteri kimliği;

https://chatter.salebot.pro/api/\<api_key>/callback****?delimiter=1delimiter_value_phone={key1}1{key2}**** - yalnızca telefon numarası;

API yöntemleri:

Botu başlat: https://chatter.mavibotbot.ai/api/\<api_key>/callback
WhatsApp numarasıyla botu başlat: https://chatter.mavibotbot.ai/api/\<api_key>/whatsapp_callback
Telegram kimliğiyle botu başlat: https://chatter.mavibotbot.ai/api/\<api_key>/tg_callback
E-posta müşterisine geri arama mesajı gönder: https://chatter.mavibotbot.ai/api/\<api_key>/email_callback
Müşteriye mesaj gönder: https://chatter.mavibotbot.ai/api/\<api_key>/message
WhatsApp mesajı gönder: https://chatter.mavibotbot.ai/api/\<api_key>/whatsapp_message
Toplu mesajlaşma: https://chatter.mavibotbot.ai/api/\<api_key>/broadcast
Değişken ata: https://chatter.mavibotbot.ai/api/\<api_key>/save_variables\

Ek yöntemlere ihtiyacınız varsa lütfen destek ekibiyle iletişime geçin.