API oluşturucu
Bazı API istek işlevleri Hesaplayıcı’da çalıştırılabilir.
İstekler şu yöntem aracılığıyla gönderilir: POST veya GET yöntemiyle, aşağıdaki biçimdeki bir URL’ye:
https://chatter.mavibot.ai/api/{api_key}/{action}
Burada:
api_key — proje ayarlarında oluşturulan API erişim anahtarı.
Token’ı bir URL isteğinde kullanmak için önce bir API anahtarı oluşturmanız gerekir.
Bunu nasıl yapacağınıza dair talimatlar "API Anahtarı Oluşturma" bölümünde verilmiştir. bağlantı
Bu sayfadan bir URL kopyalanırken bir boşluk görünebilir ve kaldırılması gerekir.
Yanlış 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ı karakterleri kullanmayın.
GET istekleri için doğru biçimi anladığınızdan emin olun.
API anahtarı nasıl oluşturulur
Eski API anahtarı oluşturma özelliği hâlâ eskisi gibi çalışır, 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.
Bir API anahtarı oluşturmak için proje ayarlarına gidin:
Ardından "Entegrasyonlar" bölümüne gidin:
"Entegrasyonlar" bölümünde "API anahtarı ekle" düğmesini bulacaksınız:
Düğmeye tıkladıktan sonra, erişim ayarları ve API anahtarı oluşturma seçenekleri içeren bir açılır 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 edin!
API işlevi, belirlediğiniz erişim izinlerine bağlıdır: yalnızca müşteri bilgilerini okuma erişimine sahip bir API anahtarı oluşturup 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 isteği kartında belirtilmiştir:
Ardından, API anahtarı için bir ad girin:
"Oluştur" düğmesine tıklayarak API anahtarını oluşturun:
Sonrasında "Bitti"ye tıklayın ve api anahtarı bölüme eklenecektir:
İhtiyacınız kadar API anahtarı ekleyebilir, her birine farklı erişim izinleri atayabilirsiniz.
Ardından, birincil proje anahtarı ayarlamanız gerekir. Bu, anahtarı #{api_key} yer tutucusuyla bir istek URL’sinde kullanmanıza olanak tanır.
Bunu yapmak için, istenen API anahtarının sağındaki "{+}" düğmesine tıklayın:
Bundan sonra, anahtarın yanında bunun birincil proje anahtarı olduğunu gösteren bir etiket görünecektir.
Birincil proje anahtarına api_key üzerinden erişebilirsiniz: gerekli anahtarı oluşturun, izinlerini ayarlayın ve onu birincil proje anahtarı olarak atayın. Ardından, Hesaplayıcı’da #{api_key} yer tutucusunu içeren istek URL’sini kullanın; bu yer tutucu birincil proje anahtarının değerini içerecektir.
Erişim ayarları olan diğer oluşturulmuş tüm anahtarlar ikincil anahtar olarak kabul edilir. İstek URL’sinde, #{api_key} yerine onların değerini kullanabilirsiniz. Bunun 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 atamanız gerekir.
Lütfen dikkat edin!
Eski yöntemle oluşturulmuş API anahtarlarınız varsa, bunlar normal şekilde çalışmaya devam edecektir. 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
Gelen veya giden her mesaj aşağıdaki JSON POST isteği olarak gönderilecektir:
Bir istek hata döndürürse yeniden denenmez. Sunucu hata döndürse bile bildirimler gönderilmeye devam edecektir.
Bir JSON isteği nasıl oluşturulur
Verilerin tabloda 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 başlayın:
İstek URL’si — çağrılacak fonksiyonun yolu. Belgelerde bu her zaman istek türünün yanındaki ilk satırda gösterilir:
Kaydedilen değerler — sonuçların kaydedileceği değişken adlarıyla birlikte yanıt parametreleri listesi, aşağıdaki biçimde:
request_parameter -> your_variable
Yanıt karmaşık yapıya sahip parametreler içeriyorsa, bunları aşağıdaki şekilde ayrıştırın:
"cell_number":{"row":4,"col":2} cell_number|row ->String; cell_number|col -> Column
İstek başlıkları — gerekiyorsa doldurun. Bu genellikle veri biçimini ve/veya erişim token’ını içerir.
JSON parametreleri — veri parametrelerini JSON biçiminde belirttiğiniz istek gövdesi. Örnek:
{"client_id": "#{recipient_id_in_builder}", "message":"Hello!"}
Yanıtın yapısını anlamak için, değişken değerini çıkarmak üzere Mesaj alanına #{custom_answer} yazın.
Ardından belgelerde "Body" bölümündeki izin verilen parametreler listelenir:
Evrensel bir webhook nasıl kullanılır
Listelenen yöntemler artık POST veya GET isteği olarak yürütülebilir.
Daha önce yöntemlerimizin sabit parametreleri vardı (örneğin client_id ve fb_id), abonelik sahibi eylemlerini tetiklemek için; bu da üçüncü taraf hizmetlerle entegrasyonda belirli sınırlamalar getiriyordu.
Artık SaleBot’un kullanıcı kimliğini bulmak için hangi istek parametresini kullanacağını belirtebilirsiniz. Şu önekli bir parametre kullanın: value_ öneki, örneğin, value_user_id veya value_group_id.
Ayrıca, callback gönderme yöntemi artık müşterinin e-postası (client_email) veya telefon numarası (client_phone).
Düğmenin callback, fb_callbackve whatsapp_callback yöntemleri belirli parametre adlarına bağlı değildir. Müşterinin telefon numarasını, e-postasını veya kimliğini içeren parametreyi belirtebilirsiniz.
Bu, bir web sitesinden webhook alımı kurarken faydalıdır.
Hangi değişkenin client_id içerdiğini belirtmek içinvalue_client_id parametresini kullanın ve bu değeri tutan parametrenin adını belirtin.
Hangi değişkenin telefon numarasını içerdiğini belirtmek içinvalue_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çinvalue_user_id kullanın.
Hangi değişkenin group_id içerdiğini belirtmek içinvalue_group_id kullanın.
Webhook içindeki mesajın kendisini içeren değişkeni belirtmek içinvalue_message kullanın (diğer parametrelerle aynı şekilde aktarılır).
Örnek:
Adreste value_client_id = my_client olarak belirtin.
https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback?value_client_id=my_client
{"my_client":49177759, "message":"Hello world"}
İstek aşağıdakine eşdeğer olacaktır:
https://chatter.mavibot.pro/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback
{"client_id":49177759, "message":"Hello world"}
Gördüğünüz gibi, değeri içeren parametre adı şu önekle başlar: value_.
Lütfen dikkat edin!
Bazı olaylar proje içinde sistem bildirimleri oluşturur.
Örneğin, mesaj alanı boş olmayan ancak müşteri metni içermeyen sistem bildirimleri vardır.
Aynı zamanda, proje "message: new_chat_member" gibi belirli içeriklere sahip mesaj kancaları da oluşturabilir.
Bu nedenle, içeriği kontrol etmek önemlidir: 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
POST https://chatter.mavibot.ai/api/#{api_key}/callback
İstek URL’si: https://chatter.mavibot.ai/api/#{api_key}/callback
Bu yöntem, bir müşteri için bir huniyi tetiklemek veya harici bir kaynaktaki bir işlemi onaylamak için kullanılabilir. Müşteri bu mesajı görmez.
Lütfen dikkat: ayrıca ilettiğiniz tüm parametreler değişkende kaydedilecektir
Callback yöntemi artık müşterinin e-postası (client_email) veya telefon numarası (client_phone) kullanılarak da tetiklenebilir.
Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme/silme izni".
Yol
api key* - erişim token’ı
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 - oluşturucudaki müşteri kimliği
message - mesaj metni
resume_bot - True (isteğe bağlı parametre). Bot duraklatılmışsa, bunu duraklatmayı kaldırmak için kullanın.
Örnek: resume_bot = True
time_shift - sayı. Belirtilirse, mesaj geçerli zamandan itibaren verilen saniye sayısı sonra gönderilecektir.
send_time - "%Y-%m-%d %H:%M:%S" biçiminde tarih ve saat (ör. "2024-10-16 13:15:59"). Bu, mesajın gönderileceği tarih ve saati ayarlar. Hem time_shift hem de send_time belirtilirse, time_shift öncelikli olacaktır.
WhatsApp numarası kullanarak botu başlatma
POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_callback
İstek URL’si: 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: ayrıca ilettiğiniz tüm parametreler değişkende kaydedilecektir
Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".
Yol
api key* - erişim token’ı
Gövde
name - müşteri adı message - mesaj metni phone - müşterinin telefon numarası bot_id - bot kimliği resume_bot - True (isteğe bağlı parametre). Bot duraklatılmışsa, bunu devam ettirmek için kullanın. Örnek: resume_bot = True
time_shift - sayı. Belirtilirse, mesaj geçerli zamandan itibaren verilen saniye sayısı sonra gönderilecektir.
send_time - "%Y-%m-%d %H:%M:%S" biçiminde tarih ve saat (ör. "2024-10-16 13:15:59"). Bu, mesajın gönderileceği tarih ve saati ayarlar. Hem time_shift hem de send_time belirtilirse, time_shift öncelikli olacaktır.
Telegram ID kullanarak botu başlatma
POST https://chatter.mavibot.pro/api/#{api_key}/tg_callback
İstek URL’si: https://chatter.mavibot.pro/api/#{api_key}/tg_callback
Bu yöntem, bir müşteri için bir huniyi tetiklemek veya harici bir web sitesindeki bir işlemi onaylamak için kullanılabilir. Müşteri bu mesajı görmez.
Lütfen dikkat: ayrıca ilettiğiniz tüm parametreler değişkenlerde kaydedilecektir.
Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".
Yol
api key* - erişim token’ı
Gövde
message - mesaj metni user_id - Telegram kullanıcı kimliği group_id - bot adı (sonu bot ile biter) resume_bot - True (isteğe bağlı parametre). Bot duraklatılmışsa, bunu devam ettirmek için kullanın. Örnek: resume_bot = True
time_shift - sayı. Belirtilirse, mesaj geçerli zamandan itibaren verilen saniye sayısı sonra gönderilecektir.
send_time - "%Y-%m-%d %H:%M:%S" biçiminde tarih ve saat (ör. "2024-10-16 13:15:59"). Bu, mesajın gönderileceği tarih ve saati ayarlar. Hem time_shift hem de send_time belirtilirse, time_shift öncelikli olacaktır.
platform_id’ye göre bir müşteri listesine callback mesajları gönderme
POST https://chatter.mavibot.ai/api/#{api_key}/send_callback_by_platform_id
İstek URL’si: https://chatter.mavibot.ai/api/#{api_key}/send_callback_by_platform_id
Listedeki platform_id’ye sahip müşteriler projede bulunduğunda, callback callback_text alanındaki metinle gönderilecektir. Sınır: 1 istek = en fazla 300 gönderim
İstek parametreleri örneği: {"platform_ids":[407184121, "79609879898", "2rwewefw"], "callback_text": "test_callback"}
Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".
Yol
api key* - erişim token’ı
Gövde
platform_ids - mesajlaşma uygulamasındaki müşteri kimlikleri listesi callback_text - callback metni group_id - bot kimliği
time_shift - sayı. Belirtilirse, mesaj geçerli zamandan itibaren verilen saniye sayısı sonra gönderilecektir.
send_time - "%Y-%m-%d %H:%M:%S" biçiminde tarih ve saat (ör. "2024-10-16 13:15:59"). Bu, mesajın gönderileceği tarih ve saati ayarlar. Hem time_shift hem de send_time belirtilirse, time_shift öncelikli olacaktır.
E-posta ile bir müşteriye callback mesajı gönderme
POST https://chatter.mavibot.ai/api/#{api_key}/email_callback
İstek URL’si: 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 yoksa oluşturacaktır.
Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".
Lütfen dikkat: ayrıca ilettiğiniz tüm parametreler değişkende kaydedilecektir
Yol
api key* - erişim token’ı
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, bunu devam ettirmek için kullanın. Örnek: resume_bot = True
time_shift - sayı. Belirtilirse, mesaj geçerli zamandan itibaren verilen saniye sayısı sonra gönderilecektir.
send_time - "%Y-%m-%d %H:%M:%S" biçiminde tarih ve saat (ör. "2024-10-16 13:15:59"). Bu, mesajın gönderileceği tarih ve saati ayarlar. Hem time_shift hem de send_time belirtilirse, time_shift öncelikli olacaktır.
Mesajlarla nasıl çalışılır
Mesaj gönderme parametreleri
attachment_type — şu olabilir: resim, video, bağlantı, dosya veya ses. Bir ek gönderirken message parametresi isteğe bağlıdır.
buttons — mesaja eklenecek butonları tanımlar. Buton biçimi gelişmiş buton ayarlarıyla aynıdır.
Butonlar iki şekilde gönderilebilir: butonları desteklemeyen mesajlaşma uygulamaları için bir ipucuyla veya ipucu olmadan.
Buton parametresi örneği:
Bir müşteriye mesaj gönderme
POST https://chatter.mavibot.ai/api/#{api_key}/message
İstek URL’si: https://chatter.mavibot.ai/api/#{api_key}/message
Bu yöntem bildirim mesajları göndermek için kullanılabilir. Bir dosya göndermiyorsanız message parametresi zorunludur. Dosya gönderiyorsanız metin isteğe bağlıdır.
Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".
Yol
api key* - erişim token’ı
Gövde
message_id - gönderim için blok numarası message - mesaj metni client_id - oluşturucudaki müşteri kimliği attachment_type - dosya gösterim türü. attachment_url sağlanmışsa zorunludur. attachment_url - dosya URL’si buttons - butonlar
time_shift - sayı. Belirtilirse, mesaj geçerli zamandan itibaren verilen saniye sayısı sonra gönderilecektir.
send_time - "%Y-%m-%d %H:%M:%S" biçiminde tarih ve saat (ör. "2024-10-16 13:15:59"). Bu, mesajın gönderileceği tarih ve saati ayarlar. Hem time_shift hem de send_time belirtilirse, time_shift öncelikli olacaktır.
WhatsApp’ta mesaj gönderme
POST https://chatter.salebot.pro/api/<api_key>/whatsapp_message
İstek URL’si: https://chatter.mavibot.pro/api/<api_key>/whatsapp_message
Bağlı bot adına belirtilen numaraya mesaj göndermenizi sağlar. whatsapp_bot_id, "Messenger’lar ve sohbetler" bölümünden alınmalıdır. Bağlı her WhatsApp hesabına oluşturucu tarafından benzersiz bir kimlik atanır.
Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".
Yol
api key* - erişim token’ı
Gövde
message_id - gönderim 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österim türü. attachment_url sağlanmışsa zorunludur. message - mesaj metni phone - alıcı telefon numarası
time_shift - sayı. Belirtilirse, mesaj geçerli zamandan itibaren verilen saniye sayısı sonra gönderilecektir.
send_time - "%Y-%m-%d %H:%M:%S" biçiminde tarih ve saat (ör. "2024-10-16 13:15:59"). Bu, mesajın gönderileceği tarih ve saati ayarlar. Hem time_shift hem de send_time belirtilirse, time_shift öncelikli olacaktır.
Toplu mesaj gönderimi
POST https://chatter.mavibot.ai/api/#{api_key}/broadcast
İstek URL’si: https://chatter.mavibot.ai/api/#{api_key}/broadcast
Bu yöntem bir toplu gönderim başlatmanıza olanak tanır.
Şunlardan birini kullanabilirsiniz birbirini dışlayan aşağıdaki seçeneklerden biri:
list parametresi — toplu gönderim belirtilen müşteri listesine gönderilecektir.
clients parametresi — toplu gönderim, müşteri kimliklerinden oluşan bir diziye gönderilecektir.
platform_ids ve group_id parametreleri — toplu gönderim, belirtilen bot (group_id) için platform_id’lerden (mesajlaşma kimlikleri) oluşan bir diziye gönderilecektir.
Yukarıdaki parametrelerden hiçbiri sağlanmazsa, toplu gönderim gönderilmeyecektir.
Gerekli parametreler: message (ve/veya attachment_type ve attachment_url) veya message_id.
Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".
Yol
api key* - erişim token’ı
Gövde
list - toplu gönderimin 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çeneklerde yok sayılır. Verilen platform_ids’ye gönderecek botu belirtir
attachment_url - dosya URL’si
attachment_type - dosya gösterim türü. attachment_url sağlanmışsa zorunludur.
buttons - butonlar
message_id - gönderim için blok numarası
shift — mesajlar arasındaki saniye sayısı. Varsayılan 0.2’dir.
time_shift - sayı. Belirtilirse, mesaj geçerli zamandan itibaren verilen saniye sayısı sonra gönderilecektir.
send_time - "%Y-%m-%d %H:%M:%S" biçiminde tarih ve saat (ör. "2024-10-16 13:15:59"). Bu, mesajın gönderileceği tarih ve saati ayarlar. Hem time_shift hem de send_time belirtilirse, time_shift öncelikli olacaktır.
Mesaj geçmişini alma
GET https://chatter.mavibot.ai/api/#{api_key}/get_history?client_id=
İstek URL’si: https://chatter.mavibot.ai/api/#{api_key}/get_history?client_id=
client_id parametresi buradan alınabilir. bağlantı
Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini okuma izni".
Yol
api key* - erişim token’ı
Gövde
client_id - müşteri kimliği
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
Mesaj geçmişini temizle
GET https://chatter.mavibot.ai/api/#{api_key}/clear_history?client_id=
İstek URL’si: 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".
Yol
api key* - erişim token’ı
Gövde
client_id - müşteri kimliği
Müşteriler nasıl atanır
Bir müşteriyi bir çalışana atama
POST https://chatter.mavibot.ai/api/#{api_key}/assign_to_user
İstek URL’si: 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 verilmezse, sistem müşteriyi kendi algoritmasına göre atayacaktır.
Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme/silme izni".
Yol
api key* - erişim token’ı
Gövde
client_id - müşteri kimliği email - çalışan e-postası (isteğe bağlı)
Müşterileri sisteme içe aktarma
POST https://chatter.mavibot.ai/api/#{api_key}/load_clients
İstek URL’si: https://chatter.mavibot.pro/api/#{api_key}/load_clients
Bu yöntem müşterileri sisteme içe aktarmanıza olanak tanır. WhatsApp müşterileri yüklerken numarayı @s.whatsapp.net son ekiyle birlikte veya olmadan herhangi bir biçimde verebilirsiniz.
Grup kimliği (group_id) BURADAN /api/<api_key>/connected_channels üzerinden alınabilir. (Eğer client_type = 13 (telefon), group_id boş bir dizedir: ""). bağlantı
Müşterinin geldiği mesajlaşma türü (client_type) BURADAN bulunabilir. bağlantı
Ö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".
Yol
api key* - erişim token’ı
Gövde
platform_id - telefon numarası group_id - grup kimliği client_type - müşterinin geldiği mesajlaşma türü
Müşterileri bir listeye ekle
POST https://chatter.mavibot.ai/api/<api_key>/add_to_list
İstek URL’si: 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".
Yol
api key* - erişim token’ı
Gövde
list_id - liste numarası clients - müşteri kimliği dizisi
Örnek: JSON parametreleri {"list_id":1170282, "clients":[411262772, 646410963]}
Müşterileri bir listeden kaldır
POST https://chatter.mavibot.ai/api/#{api_key}/remove_from_list
İstek URL’si: https://chatter.mavibot.ai/api/#{api_key}/remove_from_list
Müşterileri bir listeden kaldırır
Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".
Yol
api key* - erişim token’ı
Gövde
list_id - liste numarası clients - Mavibot oluşturucudaki müşteri numaraları dizisi (client_id değerleri)
Müşteri listesini al
GET https://chatter.mavibot.ai/api/<api_key>/get_clients
İstek URL’si: https://chatter.mavibot.a/aipi/<api_key>/get_clients
Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".
Yol
api key* - erişim token’ı
Gövde
offset – İlk öğeden itibaren uzaklık
limit – Yanıttaki öğe sayısı / Varsayılan: 500, Maksimum: 500
list – Liste numarası
reverse – Ters sıralamayı gösterir (en eski kayıttan en yeniye). Bu parametre yalnızca liste belirtilmemişse çalışır.
Durumu ve öğe dizisini döndürür.
Herhangi bir mesajlaşma uygulamasında bot abonelerinin listesini al
GET https://chatter.mavibot.ai/api/#{api_key}/subscribers
İstek URL’si: 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".
Yol
api key* - erişim token’ı
Gövde
page tag – abonelik sayfasında belirtilen etiket group – abonenin bağlı olduğu VK grup kimliği date_from – Bu tarihten sonra abone olanlar (timestamp) date_to – Bu tarihten önce abone olanlar (timestamp) client_type – Abone listesinin alınacağı Messenger kimliği. Belirtilmezse tüm müşteriler döndürülür
Değişkenlerle nasıl çalışılır
Değişken atama
POST https://chatter.mavibot.ai/api/#{api_key}/save_variables
İstek URL’si: https://chatter.mavibot.ai/api/#{api_key}/save_variables
! Bu isteğe herhangi bir sınır uygulanmaz.
Değişkenleri hem lead’e hem de müşteriye kaydetmenizi sağlar. Varsayılan olarak, değişken atama isteği bunları anlaşma değişkenlerine ekler. Müşteri profilindeki değişkenleri güncellemek için client. önekini kullanın. Örneğin, bir telefon için: client.phone.
Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".
Güncelle: clients parametresi değişkenleri toplu olarak atamanıza olanak tanır. Örnek: {"client_id":49177759, "variables":{"client.phone":"88888888888"}}
Yol
api key* - erişim token’ı
Gövde
clients – Değişken ataması için müşteri kimlikleri dizisi
client_id – Müşteri kimliği
variables – Değişkenler sözlüğü (anahtar-değer çiftleri)
Değişkenleri al
GET https://chatter.mavibot.ai/api/#{api_key}/get_variables?client_id=
İstek URL’si: 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
Yol
api key* - erişim token’ı
Gövde
client_id - müşteri kimliği
Müşteri kimliği (client_id) nasıl alınır
platform_id değeri kullanılarak client_id’yi alın
POST https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_platform_id
İstek URL’si: 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".
Yol
api key* - erişim token’ı
Gövde
platform_ids - bir mesajlaşma uygulamasındaki ID dizisi group_id - bot kimliği
Çevrimiçi sohbetten client_id’yi al
GET https://chatter.mavibot.ai/api/#{api_key}/online_chat_client_id?recipient=
İstek URL’si: https://chatter.mavibot.ai/api/#{api_key}/online_chat_client_id?recipient=
Bu yöntem, bir web sitesini bir sohbet botuyla entegre etmenizi sağlar. Örneğin, bir kullanıcı bir promosyon sayfasını ziyaret ederse, kişiselleştirilmiş bir teklif ile sohbet içinde 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 tiken
Gövde
tag - etiket (müşteri etiketi) name - müşteri adı recipient - bir web sitesindeki diyalog kimliği
Nereden alınır recipient?
Bunu Mavibot.ai çevrimiçi sohbeti olan web sitesinde alabilirsiniz, özelliği almak için JS kullanın MavibotAi.recipient_id.
WhatsApp numarasıyla client_id’yi al
GET https://chatter.mavibot.ai/api/#{api_key}/whatsapp_client_id?phone=
İstek URL’si: https://chatter.mavibot.ai/api/#{api_key}/whatsapp_client_id?phone=
Bu yöntem, müşterinin WhatsApp telefon numarasını biliyorsanız API istekleri yapmak için client ID’yi döndürür. Bu numaraya sahip bir müşteri yoksa, yöntem 404 hatası döndürür.
Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".
Yol
api key* - erişim token’ı
Gövde
phone - telefon numarası group_id - bot kimliği
Telefon numarasıyla client_id’yi al
GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_phone?phone=
İstek URL’si: https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_phone?phone=
Bu yöntem, API istekleri yapmak için client ID’yi döndürür.
Arama hem WhatsApp müşterileri arasında hem de değişkenler üzerinden yapılır.
Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini değiştirme veya silme izni".
Yol
api key* - erişim token’ı
Gövde
phone - telefon numarası
email ile client_id’yi al
GET https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_email?email=
URL isteği: https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_email?email=
Bu yöntem, API istekleri yapmak için müşteri ID’sini döndürür. Arama değişkenler kullanılarak yapılır.
Anahtar oluşturulurken erişim izni: "Müşteri 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’yi al
GET https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_var?var=&val=
İstek URL’si: https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_var?var=&val=
Bu yöntem, API istekleri yapmak için client ID’yi döndürür.
Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini okuma izni"
Yol
api key* - erişim token’ı
Gövde
var - arama yapılacak değişken adı val - değişken değerini group_id - grup ID’si search_in - deal değişkenlerinde arama yapmak için 'order' değerini verin; proje müşterileri için en fazla üç değişkende arama yapar ve belirtilen tüm değişkenlere sahip müşterilerin bir listesini döndürür.
Değişken değerine göre en son oluşturulan müşterinin ID’sini al
GET https://chatter.mavibot.ai/api/#{api_key}/find_latest_client_id_by_var?var=&val=
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 müşterinin ID’sini döndürür. Hem müşteri hem de deal değişkenlerinde arama yapar.
Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini okuma izni"
Yol
api key* - erişim token’ı
Gövde
var - arama yapılacak değişken adı val - değişken değerini
Değişken değerine göre client_id değerlerinin listesini al
GET https://chatter.mavibot.ai/api/#{api_key}/find_all_client_id_by_var?var=&val=
URL isteği: https://chatter.mavibot.ai/api/#{api_key}/find_all_client_id_by_var?var=&val=
Bu yöntem, belirtilen değere sahip belirtilen değişkeni içeren müşteri ID’lerinin bir listesini döndürür.
Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini okuma izni"
Yol
api key* - erişim token’ı
Gövde
var - arama yapılacak değişken adı val - değişken değerini
Birden fazla değişken değerine göre client_id değerlerinin listesini al
GET https://chatter.mavibot.ai/api/#{api_key}/find_all_client_id_by_several_vars?var=val
URL isteği: https://chatter.mavibot.ai/api/#{api_key}/find_all_client_id_by_several_vars?var=val
Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini okuma izni".
Yol
api key* - erişim belirteci
Gövde
variable1 - Değer1
variable2 - Değer2
variable3 - Değer3
Değişkenlere göre ara
POST https://chatter.mavibot.ai/api/#{api_key}/find_clients
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 müşteri ID’lerinin bir listesini döndürür.
Varsayılan olarak arama müşteri değişkenlerinde yapılır (önerilir): {"q": {"result": "ok", "var": "home", "var": "60"}} – müşteri belirtilen tüm değişkenlere sahip olmalıdır
Deal değişkenlerinde arama yapın; belirtilen değişkenlerden en az biri mevcut olmalıdır: {"q": {"result": "ok", "var": "home", "var": "60"}, "search_in": "order", "include_all": False}
Müşteri değişkeni adı liste değerlerinden birine eşittir: {"q": {"name": {"_in": ["Joe", "Jane", "Donald"]}}}
Müşteri değişkeni adı liste değerlerinden herhangi birine eşit DEĞİLDİR: {"q": {"name": {"_not_in": ["Joe", "Jane", "Donald"]}}}
Müşteri değişkeni adı "Joe"'ya eşit değildir: {"q": {"name": {"_not": "Joe"}}}
Not: Sayı karşılaştırması yalnızca tüm müşteriler aranan değişkende sayısal değerlere sahipse çalışır. Tek bir müşteride bile string varsa istek başarısız olur.
Anahtar oluşturulurken erişim izni: "Müşteri bilgilerini okuma izni"
Parametreler
Yol
api key* - erişim token’ı
Gövde
q – zorunlu parametre, değişkenleri aramak için sorgu koşullarını içerir
search_in – hangi varlığın değişkenlerinin aranacağını belirtir; belirtilmezse arama müşteri değişkenlerinde yapılır. order değerini alabilir.
include_all – q içindeki tüm koşulların karşılanıp karşılanmayacağı;
False – en az bir koşul eşleşirse varlık seçilir
Deals ile nasıl çalışılır
Geçerli deal ID’sini al
GET https://chatter.mavibot.ai/api/#{api_key}/get_current_order_id
İstek URL’si: https://chatter.mavibot.ai/api/#{api_key}/get_current_order_id
Anahtar oluşturulurken erişim izni: "CRM bilgilerini okuma izni".
Yol
api key* - erişim token’ı
Gövde
client_id - müşteri kimliği
Deal listesini al
GET https://chatter.mavibot.ai/api/#{api_key}/get_orders
İstek URL’si: https://chatter.mavibot.ai/api/#{api_key}/get_orders
Anahtar oluşturulurken erişim izni: "CRM bilgilerini okuma izni"
Yol
api key* - erişim token’ı
Gövde
client_id - müşteri kimliği
order_status - deal aşaması: 0 - aktif deals 1 - başarılı deals 2 - başarısız deals
Bir deal’i Mavibot funnel’ında bir sonraki aşamaya taşı
POST https://chatter.mavibot.ai/api/#{api_key}/move_order_to_next_state
İstek URL’si: https://chatter.mavibot.ai/api/#{api_key}/move_order_to_next_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
order_id - deal ID’si
Deal verilerini al
POST https://chatter.mavibot.ai/api/#{api_key}/get_order_vars
İstek URL’si: https://chatter.mavibot.ai/api/#{api_key}/get_order_vars
Anahtar oluşturulurken erişim izni: "CRM bilgilerini okuma izni"
Yol
api key* - erişim token’ı
Gövde
client_id - müşteri kimliği
order_id - deal ID’si
variables - değişken dizisi (format:["var_name1", "var_name2"])
Deal değişkenleri ekle
POST https://chatter.mavibot.ai/api/#{api_key}/set_order_vars
İstek URL’si: https://chatter.mavibot.ai/api/#{api_key}/set_order_vars
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
order_id - deal ID’si
variables - değişkenlerin bir sözlüğü (anahtar değişken adı, değer ise o değişkende saklanması gereken değerdir) (format:{"var_name": "var_velue"})
Bir deal oluştur
POST https://chatter.mavibot.ai/api/#{api_key}/create_order
İstek URL’si: https://chatter.mavibot.ai/api/#{api_key}/create_order
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
name - deal adı
description - deal açıklaması
budget - deal tutarı
İstekte aşağıdaki parametrelerden birini belirtmelisiniz: client_id, email veya phone. Birden fazla parametre sağlanırsa yalnızca biri kullanılacaktır. Öncelik sırası: client_id > phone > email. phone veya email sağlanırsa ve bu telefon numarası ya da e-posta ile mevcut bir müşteri yoksa, yeni bir müşteri oluşturulacaktır.
Bir deal’i MavibotCRM’de bir aşamaya taşı
POST https://chatter.mavibot.ai/api/#{api_key}/set_order_state
İstek URL’si: 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 deal’inin taşınması gereken aşama numarası
Mavibot CRM’de funnel aşaması ID’sini al
GET https://chatter.mavibot.ai/api/#{api_key}/get_order_state
İstek URL’si: 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 - deal ID’si (belirtilmezse, yöntem mevcut deal’in aşama ID’sini döndürür)
Başka hangi özellikler mevcut?
Bir telefon numarasının WhatsApp’ı olup olmadığını kontrol et
GET https://chatter.mavibot.ai/api/#{api_key}/check_whatsapp
İstek URL’si: 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 al
GET https://chatter.mavibot.ai/api/<api_key>/connected_channels
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üşterileri içe aktarırken kullanılması gereken her mesajlaşma uygulaması için group_id parametresini döndürür.
WhatsApp için ayrıca bir status alanını da döndürür; bu alan aşağıdaki değerleri alabilir:
NOT_STARTED = 0 STARTED = 1 ASLEEP = 2 STOPPED = 3
Yol
api key* - erişim token’ı
Bot akışındaki blokların listesini al
GET https://chatter.mavibot.ai/api/<api_key>/get_messages
İstek URL’si: 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 müşteri verilerini al
delimiter
İç içe sözlüklerden (ilk seviyede değil) client_id ve/veya müşterinin telefon numarasını almak için delimiter parametresini kullanın.
İstek URL’nize şunu 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 ID’sini almak için
delimiter_value_phone={key1}1{key2} – müşterinin telefon numarasını almak için
{key1}, {key2}, … – değerleri içeren anahtarlar (ayırıcı hariç herhangi bir karakter içerebilir). Sınırsız sayıda anahtar olabilir: ?delimiter=1&delimiter_value_client_id={key1}1{key2}1{key3}1{key4}1{key5}1{key6}. Anahtarlar süslü parantezler 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ı karakteri 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 ID’yi 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 ID’si;
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
Botu WhatsApp numarasıyla başlat: https://chatter.mavibotbot.ai/api/<api_key>/whatsapp_callback
Botu Telegram ID’siyle başlat: https://chatter.mavibotbot.ai/api/<api_key>/tg_callback
E-posta müşterisine callback 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şkenleri ata: https://chatter.mavibotbot.ai/api/<api_key>/save_variables
Ek yöntemlere ihtiyacınız varsa, lütfen destekle iletişime geçin.
Son güncelleme