İstekler POST yöntemiyle şu URL'ye yapılır: https://chatter.mavibot.ai/api/{api\_key}/{action}

Nerede bulunur: api_key, proje ayarlarından elde edilen API'ye erişim anahtarıdır:

Erişim anahtarını #{api_key} değişkenini kullanarak alabilirsiniz. İlgili oluşturulan anahtarı tutar. Kullanmadan önce bir tane oluşturmayı unutmayın.

Bu sayfadan sorgunun URL'sini kopyalarken, çağrı yaparken silinmesi gereken bir boşluk konur

Bağlantıyı yanlış şekilde kopyalama örneği: https://chatter.mavibot.ai/api/callback 

.pro'dan sonraki boşluğu fark etmemek kolaydır, ancak yerinde bırakılırsa sorgu çalışmaz

GET yöntemiyle istek gönderirken yasaklı kelimeler kullanmayın. GET isteklerinin doğru oluşumuna bakın

Proje ayarlarında belirtilen Webhook URL'sine mesaj nasıl alınır

Proje ayarları

Her gelen veya giden mesaj, aşağıdaki json POST istekleriyle birlikte gelir:

{
    'id': mesajın sistemdeki tanımlayıcısı,
    'client': {
        'id': müşterinin sistemdeki tanımlayıcısı,
        'recepient': müşterinin mesajlaşma uygulamasındaki tanımlayıcısı,
        'client_type': mesajlaşma uygulamasının türü,
        'name': müşterinin adı,
        'avatar': müşterinin avatarı,
        'created_at': müşterinin oluşturulma tarihi,
        'tag': abonelik anahtarı,
        'group': müşterinin bağlı olduğu bot,
    },
    'message': mesaj metni,
    'attachments': dosya bağlantıları dizisi,
    'message_id': mesajın gönderildiği bloğun kimliği,
    'project_id': projenin 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': hatayı açıklayan mesaj
}

İstek bir hatayla döndüyse yeniden gönderilmez. Sunucu bir hatayla döndüyse, buna rağmen bildirimler gelmeye devam eder.

Evrensel webhook nasıl kullanılır

Bu yöntemler artık hem POST hem de GET isteği ile başlatılabilir.

Daha önce, parametreler (müşteri yöntemlerinin başlatıldığı, yani client_id) yöntemlerimizde çok katı bir şekilde yazılmıştı ve bu, üçüncü taraf hizmetlerle kullanıldığında bazı kısıtlamalar getiriyordu.

Artık Mavibot'un kullanıcının tanımlayıcısını isteğin hangi parametresinde arayacağını belirtebilirsiniz: bunun için value_ ön ekine sahip bir parametre kullanılır, örneğin value_user_id ve value_group_id.

Ayrıca geri arama gönderme yöntemi callback, bir e-posta (client_email) ve bir müşteri telefon numarası (client_phone) iletilerek başlatılabilir.

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

Bu, webhook alımını başka bir site üzerinden ayarlarken kullanışlıdır.

Hangi değişkenin client_id tuttuğunu belirtmek için value_client_id değerini aktarmanız ve bu değere sahip parametrenin adını belirtmeniz gerekir

Hangi değişkenin telefon tuttuğunu belirtmek için value_phone değerini aktarmanız ve bu değere sahip parametrenin adını belirtmeniz gerekir

Hangi değişkenin e-posta tuttuğunu belirtmek için value_email değerini aktarmanız ve bu değere sahip parametrenin adını belirtmeniz gerekir

Hangi değişkenin user_id tuttuğunu belirtmek için value_user_id değerini aktarmanız ve bu değere sahip parametrenin adını belirtmeniz gerekir

Hangi değişkenin group_id tuttuğunu belirtmek için value_group_id değerini aktarmanız ve bu değere sahip parametrenin adını belirtmeniz gerekir

Örnek:

Adrese value_client_id = my_client yazın

https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback?value_client_id=my_client
{"my_client":49177759, "message":"Hello world"}

Sorgu, aşağıdaki sorguya eşdeğer olacaktır:

https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback
{"client_id":49177759, "message":"Hello world"}

Gördüğünüz gibi, adı tutan parametrenin adı value_ ön ekiyle ayırt edilir

Bot nasıl başlatılır

Botun başlatılması

POST https://chatter.mavibot.ai/api/<api_key>/callback

Bu yöntem, müşteri için iş akışını başlatmak veya üçüncü taraf bir hizmetteki eylemi onaylamak için kullanılabilir. Bu mesaj müşteri tarafından görülmez.
Ek olarak aktarılan parametreler değişkenlere kaydedilir.
Geri arama gönderme yöntemi artık bir e-posta (client_email) veya müşterinin telefon numarası (client_phone) paylaşılarak açılabilir

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim belirteci

İstek Gövdesi

Ad Tür Açıklama
client_phone string müşterinin bulunduğu telefon numarası
client_email string müşterinin bulunduğu e-posta
client_id string düzenleyicideki müşterinin kimliği
message string mesaj metni

**200: OK **

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

Botu WhatsApp üzerinden numara ile başlatma

POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_callback

Bu yöntem, müşteri site üzerinden kaydolduktan veya telefon numarasıyla bir talep bıraktıktan sonra WhatsApp'ta botu başlatır
Ek olarak aktarılan parametreler değişkenlere kaydedilir

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim belirteci

İstek Gövdesi

Ad Tür Açıklama
name string müşterinin adı
message string mesaj metni
phone string müşterinin telefon numarası
bot_id string botun kimliği

**200: OK **

{
    // Yanıt
}

Botu Telegram kimliği ile başlatma

POST https://chatter.mavibot.ai/api/<api_key>/tg_callback

Bu yöntem, iş akışını başlatmak veya üçüncü taraf bir sitedeki eylemleri onaylamak için kullanılabilir. Bu mesaj müşteri tarafından görülmez.

Ek olarak aktarılan parametreler değişkenlere kaydedilir

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim belirteci

İstek Gövdesi

Ad Tür Açıklama
message string mesaj metni
user_id string Telegram'daki kullanıcının kimliği
group_id string botun adı (bot ile bitmelidir)

**200: OK **

{
    // Yanıt
}

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

Mesaj gönderme parametreleri

attachment_type şu değerleri alabilir: image, video, link, file, audio
Ek gönderirken message parametresi zorunlu değildir

buttons, mesaja eklenecek düğmeleri tanımlar. Düğmelerin formatı, düğmenin gelişmiş ayarlarıyla karşılaştırılabilir. Düğmelerin iletilmesinin iki varyantı mümkündür: düğmesiz mesajlaşma uygulamalarında araç ipucu olan ve olmayan

İşte düğmeler parametresine bir örnek:

"buttons": {"hint": "Bu metin Whatsapp'ta gösterilecek",
 "buttons": [
    {"type": "reply", 
     "text": "Hangi hizmetleri sağlayabiliriz", 
     "line": 0, "index_in_line": 0}, 
       
    {"type": "reply", 
     "text": "Ödeme bilgisi", 
     "line": 0, 
     "index_in_line": 1}, 
        
    {"type": "reply", 
     "text": "İletişim bilgilerimiz", 
     "line": 1, "index_in_line": 0}, 
        
    {"type": "reply", 
     "text": "Başvuru bırak", 
     "line": 1, "index_in_line": 1}
   ] 
}

Müşteriye mesaj gönderme

POST https://chatter.mavibot.ai/api/<api_key>/message

Bu yöntem, bildirimlerle mesaj göndermek için kullanılabilir. Bir dosya göndermiyorsanız message parametresi zorunludur. Gönderiyorsanız, metin gerekli değildir

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim anahtarı

İstek Gövdesi

Ad Tür Açıklama
message_id string gönderen bloğun numarası
message string mesaj metni
client_id string düzenleyicideki müşterinin kimliği
attachment_type string dosya görüntüleme türü
attachment_url string dosyanın URL'si
buttons object düğmeler

**200: OK **

import requests
import json

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

WhatsApp'ta mesaj gönderme

POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_message

Bağlı botun adına belirtilen numaraya bir mesaj göndermeye izin verir whatsapp_bot_id "Mesajlaşma uygulamaları ve sohbetler" bölümünden alınmalıdır. Bağlı her WhatsApp sayfası benzersiz bir kimlik alır

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim anahtarı

İstek Gövdesi

Ad Tür Açıklama
message_id string gönderen bloğun numarası
whatsapp_bot_id number mesajı gönderen WhatsApp botu
attachment_url string dosyanın url'si
attachment_type string dosya görüntüleme türü
message string mesaj metni
phone string alıcının telefon numarası

**200: OK **

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

POST https://chatter.mavibot.ai/api/<api_key>/broadcast

Yöntem, mesaj dağıtımına izin verir. clients parametresi belirtilmezse, yayın tüm kullanıcılara gönderilir. Bir dosya veya metin göndermek gerekir.

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim anahtarı

İstek Gövdesi

Ad Tür Açıklama
message_id string gönderme bloğunun numarası
list string alıcı numaralarının listesi
shift string mesajlar arasındaki saniye cinsinden süre. Varsayılan 0.2
message string mesaj metni
clients array alıcıların kimlikleri
attachment_type string dosya görüntüleme türü
attachment_url string dosyanın URL'si
buttons string butonlar

**200: OK **

{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

GET https://chatter.mavibot.ai/api/<api_key>/get_history?client_id=

Mesaj geçmişini alır. client_id parametresini BURADAN alabilirsiniz.

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim anahtarı

Sorgu Parametreleri

Ad Tür Açıklama
client_id string istemcinin kimliği

**200: OK **

{
  "status": "success",
  "result": [
    {
      "id": 104500,
      "answered": true,
      "client_replica": false,
      "message_id": 390,
      "message_from_outside": 0,
      "created_at": 1587895014,
      "text": "CouCou",
      "attachments": {
        
      },
      "delivered": true,
      "error_message": "true"
    },
  ]
}

Mesaj geçmişini temizleme

GET https://chatter.mavibot.ai/api/<api_key>/clear_history?client_id=

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim anahtarı

Sorgu Parametreleri

Ad Tür Açıklama
client_id string istemcinin kimliği

**200: OK **

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 dağıtılır

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

GET https://chatter.mavibot.ai/api/<api_key>/assign_to_user

Yöntem, bir müşteriyi bir çalışana atamaya izin verir. E-posta parametresi isteğe bağlıdır. E-posta sağlanmazsa, sistemin algoritması aracılığıyla dağıtılır.

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim anahtarı

Sorgu Parametreleri

Ad Tür Açıklama
client_id String istemcinin kimliği
e-mail String çalışanın e-postası (isteğe bağlı)

**200: OK **

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)

Müşterileri sisteme yükleme

GET https://chatter.mavibot.ai/api/<api_key>/load_clients

Yöntem, müşterileri sisteme yüklemeye izin verir. WhatsApp müşterileri yüklenirken numarayı sonunda @s.whatsapp.net ile veya onsuz serbestçe aktarabilirsiniz.

Grup kimliğini (group_id) buradan /api/<api_key>/connected_channels aracılığıyla alabilirsiniz.

(eğer client_type=13 (telefon) ise group_id=””)

Müşterinin hangi mesajlaşma uygulamasından geldiğini (client_type) görebilirsiniz.

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

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim anahtarı

İstek Gövdesi

Ad Tür Açıklama
platform_id String telefon numarası
group_id String grup kimliği
client_type String müşterinin geldiği mesajlaşma uygulamasının türü

**200: OK **

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ı olması durumunda fonksiyon her bir öğeye kimliğini ve ekleme durumunu döndürür
# cevap örneği
# {"status":"success","items":[{"platform_id":"[email protected]","group_id":"5kqchxwyvdvFZOsp80q2qw==","client_type":6,"status":"success","id":1469409}]}

Müşterileri listeye ekleme

POST https://chatter.mavibot.ai/api/<api_key>/add_to_list

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim anahtarı

İstek Gövdesi

Ad Tür Açıklama
list_id integer listenin numarası
clients array müşteri numaraları dizisi

**200: OK **

{
    // Cevap
}

Müşterileri listeden çıkarma

POST https://chatter.mavibot.ai/api/<api_key>/remove_from_list

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim anahtarı

İstek Gövdesi

Ad Tür Açıklama
list_id integer listenin numarası
clients array müşteri numaraları dizisi

**200: OK **

{
    // Cevap
}

Müşteri listesini alma

POST https://chatter.mavibot.ai/api/<api_key>/get_clients

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim anahtarı

Sorgu Parametreleri

Ad Tür Açıklama
offset string ilk öğeden itibaren kaydırma
limit integer cevaptaki öğe sayısı. Varsayılan 500, maks. 500
list string listenin numarası

200: OK Öğelerin durumunu ve 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 abone listesini alma

POST https://chatter.mavibot.ai/api/<api_key>/subscribers

Seçilen mesajlaşma uygulamasındaki müşteriler hakkında bilgi alma

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim anahtarı

Sorgu Parametreleri

Ad Tür Açıklama
page integer
tag string abonelik sayfasında belirtilen etiket
group integer abonenin bağlı olduğu grubun kimliği
date_from integer abone olduktan sonraki tarihin zaman damgası
date_to integer abone olduğu tarihe kadar olan zaman damgası
client_type integer alt listesine ihtiyaç duyulan mesajlaşma uygulamasının kimliği. Değiştirilmezse tüm müşteriler gelir

**200: OK **

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

Müşterileri silme izni

POST ``https://chatter.mavibot.ai/api/<api_key>/get_clients

Anahtar oluşturulurken erişim izni: “Müşterileri silme izni”

Parametreler

Yol
api key* — erişim belirteci

Gövde
client_ids — silinecek müşteri kimliklerinin listesi. Maksimum 500. Örnek: [199571, 199707, 1935722]

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

Değişken atama

POST https://chatter.mavibot.ai/api/<api_key>/save_variables

Uygulamada ve müşteride değişken kaydetmeye izin verir.
Değişken atama isteği varsayılan olarak işlem değişkenlerine eklenir.
Profildeki değişkenleri değiştirmeniz gerekiyorsa client önekini eklemeniz gerekir.
Örn. mobil için: client.phone

clients parametresi toplu olarak değişken atamaya izin verir

Örn.: {"client_id":49177759, "variables":
{"client.phone":"1234567890"}}

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim anahtarı

İstek Gövdesi

Ad Tür Açıklama
clients array değişken atamak için müşteri kimlik dizisi
client_id string müşterinin kimliği
variables object değişen karma (anahtar değer)

**200: OK **

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

GET https://chatter.mavibot.ai/api/<api_key>/get_variables?client_id=

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim belirteci

Sorgu Parametreleri

Ad Tür Açıklama
client_id string müşteri kimliği

**200: OK **

import requests
import json


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

client_id nasıl alınır

platform_id değerine göre client_id alma

POST https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_platform_id

Bu yöntem, API'ye istek göndermek için gerekli olan client id'yi döndürür.

Parametre örneği: {"platform_ids": ["571830542", "256865200"]}

Yol Parametreleri

Ad Tür Açıklama
string erişim anahtarı

İstek Gövdesi

Ad Tür Açıklama
platform_ids string mesajlaşma uygulamasındaki kimlik dizisi

**200: Başarılı **

[{
"id":15099119,
"tag":null,
"created_at":1618815253,
"name":"Oscar Wilde",
"avatar":"https:\/\/files.mavibot.pro\/uploads\/avatars\/256865200.jpg",
"platform_id":"2568652",
"group":"Mavibotpro_bot",
"variables":{"tg_username":"@wildeo"}},

{"id":21087377,
"tag":null,
"created_at":1626275893,
"name":"Freddie Mercury",
"avatar":"https:\/\/files.mavibot.pro\/uploads\/avatars\/571830542.jpg",
"platform_id":"571830542",
"group":"Mavibotpro_bot",
"variables":{"tg_username":"@freddieisqueen"}
}]

Online sohbet üzerinde client id nasıl alınır

GET https://chatter.mavibot.ai/api/<api_key>/online_chat_client_id?recipient=

Bu yöntem, site ve sohbet robotunun entegre edilmesini sağlar; yani bir kişi özel teklifin bulunduğu sayfaya girdiyse, teklif hakkında sohbette anında bir mesaj gönderebilirsiniz.

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim belirteci

Sorgu Parametreleri

Ad Tür Açıklama
tag string müşteri etiketi
name string müşterinin adı
recipient string sitedeki diyalog kimliği

**200: Başarılı **

{ "client_id": 36553 }

Alıcıyı nereden alıyorsunuz? "Mavibot.ai" çevrimiçi sohbetini taşıyan sitede, JS yardımıyla MaviBotPro.recipient_id özelliğini almanız gerekir.

WhatsApp numarası ile client id nasıl alınır

GET https://chatter.mavibot.ai/api/<api_key>/whatsapp_client_id?phone=

Bu yöntem, müşterinin WhatsApp'taki telefon numarasını biliyorsanız, API'ye istek göndermek için client id'yi döndürür.
Bu numaraya sahip böyle bir müşteri yoksa, 404 hatası alırsınız.

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim belirteci

Sorgu Parametreleri

Ad Tür Açıklama
phone string telefon numarası

**200: Başarılı **

{
    // Yanıt
}

Telefon numarası ile client id alma

GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_phone?phone=

Bu yöntem, API'ye istek göndermek için client id'yi döndürür.
Arama, WhatsApp müşterileri ve değişkenler üzerinden yapılır.

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim belirteci

Sorgu Parametreleri

Ad Tür Açıklama
phone string telefon numarası

**200: Başarılı **

{
    // Yanıt
}

E-posta yoluyla client id alma

GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_email?email=

Bu yöntem, API'ye istek göndermek için client id'yi döndürür. Arama, değişkenler üzerinden yapılır.

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim belirteci

Sorgu Parametreleri

Ad Tür Açıklama
email string arama için e-posta

**200: Başarılı **

{
    // Yanıt
}

Değişken değerine göre client id alma

GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_var?var=&val=

Bu yöntem, API'ye istek göndermek için client id'yi döndürür.

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim belirteci

Sorgu Parametreleri

Ad Tür Açıklama
var string aramanın yapılacağı değişkenin adı
val string değişken değeri

**200: Başarılı **

{
    // Yanıt
}

Başka hangi olasılıklar var

İşlemi MavibotCRM durumuna taşıma

POST https://chatter.mavibot.ai/api/<api_key>/set_order_state

İşlem numarası, MavibotCRM iş akışı düzenleme penceresinden alınabilir.

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim anahtarı

İstek Gövdesi

Ad Tür Açıklama
client_id string müşterinin kimliği
state_id string müşterinin işleminin taşınacağı durum numarası

**200: Başarılı **

{
    // Yanıt
}

Kişinin Instagram hesabını takip edip etmediğini kontrol etme

GET https://chatter.mavibot.ai/api/<api_key>/check_insta_subscription

Hem POST yöntemiyle hem de GET yöntemiyle çağrılabilir.

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim anahtarı

İstek Gövdesi

Ad Tür Açıklama
user_name string kontrol etmek istediğiniz müşterinin kullanıcı adı
login string kontrol edilen botun giriş bilgisi

200: Başarılı is_follower alanı, kişinin takip edip etmediğine dair bilgiyi tutar

{
"username": "beyonce",
"account_id": "1463220603",
"avatar": "https://instagram.fhel6-1.fna.fbcdn.net/v/t51.2885-19/1060168..",
"real_name": "Beyonce",
"is_follower": true,
"status": 200
}

Telefon numarasının WhatsApp taşıyıp taşımadığını kontrol etme

GET https://chatter.mavibot.ai/api/<api_key>/check_whatsapp

Yöntemi kullanmak için WhatsApp ve Mavibot'u bağlamış olmanız GEREKİR

Hem POST yöntemiyle hem de GET yöntemiyle çağrılabilir.
Telefon numarası herhangi bir formatta aktarılabilir.

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim belirteci

İstek Gövdesi

Ad Tür Açıklama
phone string telefon numarası

**200: Başarılı **

{
    // Yanıt
}

Projeye bağlı mesajlaşma uygulamalarının listesini alma (group_id dahil)

GET https://chatter.mavibot.ai/api/<api_key>/connected_channels

Fonksiyon, her mesajlaşma uygulamasına group_id parametresini döndürür ve müşteriler yüklenirken aktarılması gereken de budur.

Ayrıca WhatsApp için status alanı döndürülür ve şu değerleri tutar:
NOT_STARTED = 0
STARTED = 1
ASLEEP = 2
STOPPED = 3

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim belirteci

**200: Başarılı **

{'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': [] 
}

Bot şemasındaki blokların listesini alma

GET https://chatter.mavibot.ai/api/<api_key>/get_messages

Yol Parametreleri

Ad Tür Açıklama
api_key string erişim belirteci

**200: Başarılı **

{
    // Yanıt
}

Ek yöntemlere ihtiyacınız varsa, lütfen müşteri desteğiyle iletişime geçin.