Düzenleme yazılımının API'si

Düzenleme yazılımının hangi istekleri desteklediği ve bunların nasıl yapılacağı

• Proje ayarlarında belirtilen Webhook URL’sine mesajlar nasıl alınır

• Evrensel bir webhook nasıl kullanılır

• Bot nasıl başlatılır

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

• Müşteriler nasıl dağıtılır

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

• client_id nasıl alınır

• Başka hangi imkanlar var

İstekler yöntemle gerçekleştirilir POST şu URL’de yani https://chatter.mavibot.ai/api/{api_key}/{action}

Nerede bulunduğu: api_key proje ayarlarında elde edilen API’ye erişim anahtarıdır:

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

Bu sayfadaki sorgu URL’si kopyalanırken içine bir boşluk eklenir; çağırırken bu boşluğun silinmesi gerekir

Bağlantıyı yanlış şekilde kopyalamaya örnek: https://chatter.mavibot.ai/api/callback

.pro’dan sonraki boşluğu fark etmek kolay değildir, ancak bırakılırsa sorgu çalışmaz

İsteği GET yöntemiyle gönderirken yasaklı kelimeleri kullanmayın. GET isteklerinin doğru biçimlendirilmesine bakın

Proje ayarlarında belirtilen Webhook URL’sine mesajlar nasıl alınır

Projenin ayarları

Gelen veya giden her mesaj aşağıdaki json POST istekleriyle gelir:

{
    'id': sistemdeki mesajın tanımlayıcısı,
    'client': {
        'id': sistemdeki müşterinin tanımlayıcısı,
        'recepient': mesajlaşma uygulamasındaki müşterinin 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şturulduğu tarih,
        'tag': abonelik anahtarı,
        'group': müşterinin bağlı olduğu bot,
    },
    'message': mesaj metni,
    'attachments': dosyalara giden bağlantı dizisi,
    'message_id': mesajın gönderildiği blokun id’si,
    'project_id': projenin id’si,
    'is_input': mesaj müşteriden geldiyse 1, bot’tan geldiyse 0,
    'delivered': mesaj başarıyla gönderildiyse 1, hata varsa 0,,
    'error_message': hatayı açıklayan mesaj
}

İstek bir hata ile dönerse tekrar gönderilmez. Ancak sunucu hata dönerse buna rağmen bildirimler iletilir.

Evrensel bir webhook nasıl kullanılır

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

• callback

• whatsapp_callback

• message

• whatsapp_message

Daha önce, müşterilerin yöntemlerinin başlatıldığı parametreler, yani client_idyöntemlerimizde çok sıkı bir şekilde yazılıydı ve bunları üçüncü taraf hizmetlerle kullanırken bazı kısıtlamalar getiriyordu.

Şimdi Mavibot’un istek içinde kullanıcının tanımlayıcısını hangi parametrede arayacağını belirtebilirsiniz: bunun için ön eki olan bir parametre value_ kullanılır, örneğin value_user_id ve value_group_id.

Ayrıca callback gönderme yöntemi callback bir e-posta (client_email) ve müşterinin telefon numarası (client_phone).

Yöntemler callback ve whatsapp_callback ) aktararak başlatılabilir; bunlar parametre adlarına bağlı değildir. Hangi parametrenin müşterinin telefon numarasını, e-postasını ve id’sini tutacağını belirtebilirsiniz.

Webhook alımını başka bir site üzerinden kurarken kullanışlıdır.

client_id’nin hangi değişkende tutulduğunu belirtmek için şunu aktarmanız gerekir value_client_id ve bu değeri içeren parametrenin adını belirtin

telefonun hangi değişkende tutulduğunu belirtmek için şunu aktarmanız gerekir value_phone ve bu değeri içeren parametrenin adını belirtin

e-postanın hangi değişkende tutulduğunu belirtmek için şunu aktarmanız gerekir value_email ve bu değeri içeren parametrenin adını belirtin

user_id’nin hangi değişkende tutulduğunu belirtmek için şunu aktarmanız gerekir value_user_id ve bu değeri içeren parametrenin adını belirtin

group_id’nin hangi değişkende tutulduğunu belirtmek için şunu aktarmanız gerekir value_group_id ve bu değeri içeren parametrenin adını belirtin

Örnek:

Adres alanına 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 sorgunun eşdeğeri olacaktır:

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

Gördüğünüz gibi, adı tutan parametrenin adı şu ön ek ile ayırt edilir value_

Bot nasıl başlatılır

Botun başlatılması

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

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üşteriye görünmez. Ek olarak aktarılan parametreler değişkenlerde saklanır. Callback gönderme yöntemi artık bir e-posta (client_email) veya müşterinin telefon numarası (client_phone) paylaşarak etkinleştirilebilir

Yol Parametreleri

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

İstek Gövdesi

Name	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üzenleyicide müşterinin id’si
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)

WhatsApp’taki numara üzerinden botu başlatma

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

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

Yol Parametreleri

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

İstek Gövdesi

Name	Tür	Açıklama
name	string	müşterinin adı
message	string	mesaj metni
phone	string	müşterinin telefon numarası
bot_id	string	botun id’si

200: OK

{
    // Yanıt
}

Telegram id üzerinden bot başlatma

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

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

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

Yol Parametreleri

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

İstek Gövdesi

Name	Tür	Açıklama
message	string	mesaj metni
user_id	string	Telegram’daki kullanıcının id’si
group_id	string	botun adı (şununla bitmelidir bot)

200: OK

{
    // Yanıt
}

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

Mesaj göndermek için parametreler

attachment_type şu değerleri alabilir: resim, video, bağlantı, dosya, ses Ek gönderirken parametre message zorunlu değildir

buttons mesaja eklenecek butonları belirler. Butonların formatı, gelişmiş buton ayarlarıyla karşılaştırılabilir. Butonların iletilmesinin iki türü mümkündür: biri butonsuz mesajlaşma uygulamalarında ipucu ile, diğeri ise ipucu olmadan

İşte buttons parametresine bir örnek:

"buttons": {"hint": "Bu metin Whatsapp'ta gösterilecek",
 "buttons": [
    {"type": "reply", 
     "text": "Hangi hizmetleri sunabiliriz", 
     "line": 0, "index_in_line": 0}, 
       
    {"type": "reply", 
     "text": "Ödeme bilgileri", 
     "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}
   ] 
}

Mesajı müşteriye gönderme

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

Bu yöntem, bildirim içeren mesajlar göndermek için kullanılabilir. Parametre message bir dosya göndermiyorsanız zorunludur. Gönderiyorsanız, metin gerekli değildir

Yol Parametreleri

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

İstek Gövdesi

Name	Tür	Açıklama
message_id	string	gönderme bloğunun numarası
message	string	mesaj metni
client_id	string	düzenleyicideki müşterinin id’si
attachment_type	string	dosya gösterim türü
attachment_url	string	dosyanın URL’si
buttons	nesne	buttons

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ıyla belirtilen numaraya mesaj göndermeyi sağlar whatsapp_bot_id “Messengerlar ve sohbetler” bölümünden alınmalıdır. Bağlanan her WhatsApp sayfası benzersiz bir kimlik alır

Yol Parametreleri

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

İstek Gövdesi

Name	Tür	Açıklama
message_id	string	gönderme bloğunun numarası
whatsapp_bot_id	numara	mesajı gönderen WhatsApp botu
attachment_url	string	dosyanın url’si
attachment_type	string	dosya gösterim 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. Eğer parametre clients belirtilmezse, yayın tüm kullanıcılara gönderilir. Bir dosya veya bir metin göndermek gereklidir

Yol Parametreleri

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

İstek Gövdesi

Name	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 miktarı. Varsayılan olarak 0.2
message	string	mesaj metni
clients	dizi	alıcıların id’leri
attachment_type	string	dosya gösterim türü
attachment_url	string	dosyanın URL’si
buttons	string	buttons

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 alma. Şu değeri alabilirsiniz client_id param BURADA

Yol Parametreleri

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

Sorgu Parametreleri

Name	Tür	Açıklama
client_id	string	müşterinin id’si

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

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

Sorgu Parametreleri

Name	Tür	Açıklama
client_id	string	müşterinin id’si

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 olanak sağlar. E-posta parametresi isteğe bağlıdır. E-posta sağlanmazsa, sistemin algoritmasıyla dağıtılacaktır

Yol Parametreleri

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

Sorgu Parametreleri

Name	Tür	Açıklama
client_id	Dize	müşterinin id’si
e-posta	Dize	ç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 olanak sağlar. WhatsApp müşterilerini yüklerken numarayı @s.whatsapp.net ile birlikte sona ekleyerek ya da eklemeden serbestçe aktarabilirsiniz.

grup id’sini alabilirsiniz (group_id) burada /api/<api_key>/connected_channels üzerinden

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

Müşterinin hangi mesajlaşma uygulamasından geldiği türünü görebilirsiniz (client_type)

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

Yol Parametreleri

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

İstek Gövdesi

Name	Tür	Açıklama
platform_id	Dize	telefon numarası
group_id	Dize	grup id’si
client_type	Dize	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 işlev, her elemana kendi id’sini ve ek 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

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

İstek Gövdesi

Name	Tür	Açıklama
list_id	bir tam sayıdır	listenin numarası
clients	dizi	müşterilerin numaralarının dizisi

200: OK

{
    // Yanıt
}

Müşterileri listeden kaldırma

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

Yol Parametreleri

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

İstek Gövdesi

Name	Tür	Açıklama
list_id	bir tam sayıdır	listenin numarası
clients	dizi	müşterilerin numaralarının dizisi

200: OK

{
    // Yanıt
}

Müşteri listesini alma

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

Yol Parametreleri

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

Sorgu Parametreleri

Name	Tür	Açıklama
offset	string	ilk elemandan itibaren kaydırma
limit	bir tam sayıdır	cevaptaki öğe sayısı. Varsayılan 500, en fazla 500
list	string	listenin numarası

200: OK Öğelerin durumunu ve diziyi 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 abonelerin 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

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

Sorgu Parametreleri

Name	Tür	Açıklama
page	bir tam sayıdır
tag	string	t abonelik sayfasında belirtilen etiket
group	bir tam sayıdır	abonelerin bağlı olduğu grubun id’si
date_from	bir tam sayıdır	abone oldukları tarihten sonraki zaman damgası
date_to	bir tam sayıdır	abone oldukları tarihe kadar olan zaman damgası
client_type	bir tam sayıdır	aboneleri listelemeniz gereken mesajlaşma uygulamasının id’si. Hiçbir şey değiştirmezseniz 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ştururken erişim izni: “Müşterileri silme izni”

Parametreler

Yol api key* — erişim belirteci

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

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

Değişkenleri ilişkilendirme

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

Uygulamada ve müşteride değişkenleri kaydetmeye olanak sağlar. Değişkenleri ilişkilendirme isteği varsayılan olarak işlem değişkenlerine ekler. Değişkenleri profilde değiştirmek istiyorsanız ön ekini eklemeniz gerekir client. Örn. mobil için: client.phone

Parametre clients değişkenlerin toplu olarak ilişkilendirilmesine olanak sağlar

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

Yol Parametreleri

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

İstek Gövdesi

Name	Tür	Açıklama
clients	dizi	değişken atamak için müşterilerin id dizisi
client_id	string	müşterinin id’si
değişkenler	nesne	değişken karması (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

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

Sorgu Parametreleri

Name	Tür	Açıklama
client_id	string	müşteri id’si

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ğeriyle client_id alma

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

Yöntem, API’ye istekleri gerçekleştirmek için müşteri id’sini döndürür

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

Yol Parametreleri

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

İstek Gövdesi

Name	Tür	Açıklama
platform_ids	string	mesajlaşma uygulamasındaki id dizisi

200: OK

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

{"id":21087377,
"tag":null,
"created_at":1626275893,
"name":"Freddie Mercury",
"avatar":"https:\\/\\/files.salebot.pro\\/uploads\\/avatars\\/571830542.jpg",
"platform_id":"571830542",
"group":"Salebotpro_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 chatbot’u entegre etmeye olanak sağlar; yani bir kişi özel teklif sayfasına girdiyse, sohbet içinde teklif hakkında anında bir mesaj gönderebilirsiniz

Yol Parametreleri

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

Sorgu Parametreleri

Name	Tür	Açıklama
tag	string	müşteri etiketi
name	string	müşterinin adı
alıcı	string	sitedeki diyalog id’si

200: OK

{ "client_id": 36553 }

Alıcıyı nereden alırsınız? Online sohbet “Mavibot.ai” taşıyan sitede, JS yardımıyla SaleBotPro.recipient_id özelliğini almanız gerekir.

WhatsApp numarasıyla 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 telefon numarasını biliyorsanız, API’ye istekler için client id’yi geri verir. Bu numarayla böyle bir müşteri yoksa 404 alırsınız.

Yol Parametreleri

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

Sorgu Parametreleri

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

200: OK

{
    // Yanıt
}

Telefon numarasıyla client id alma

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

Yöntem, API’ye istekler için client id’yi geri verir. Arama hem WhatsApp müşterileri hem de değişkenler üzerinden yapılır.

Yol Parametreleri

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

Sorgu Parametreleri

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

200: OK

{
    // Yanıt
}

E-posta ile client id alma

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

Yöntem, API’ye istekler için client id’yi geri verir. Arama değişkenler üzerinden yapılır.

Yol Parametreleri

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

Sorgu Parametreleri

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

200: OK

{
    // Yanıt
}

değişken değeriyle client id alma

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

Yöntem, API’ye istekler için client id’yi geri verir

Yol Parametreleri

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

Sorgu Parametreleri

Name	Tür	Açıklama
var	string	arama yapılacak değişkenin adı
val	string	değişken değeri

200: OK

{
    // Yanıt
}

Başka hangi imkanlar var

İşlemi MavibotCRM durumuna taşıma

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

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

Yol Parametreleri

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

İstek Gövdesi

Name	Tür	Açıklama
client_id	string	müşterinin id’si
state_id	string	müşterinin işleminin aktarılacağı durum numarası

200: OK

{
    // 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öntemi hem de GET yöntemiyle çağrılabilir

Yol Parametreleri

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

İstek Gövdesi

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

200: OK is_follower alanı, kişinin takip edip etmediği bilgisini 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 kullanıp kullanmadığını kontrol etme

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

Yöntemi kullanmak için WhatsApp ve Mavibot’u BAĞLAMIŞ olmanız gerekir

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

Yol Parametreleri

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

İstek Gövdesi

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

200: OK

{
    // Yanıt
}

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

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

İşlev, parametreyi döndürür group_id her mesajlaşma uygulaması için ve müşterileri yüklerken aktarılması gereken budur

Alan status WhatsApp için de döndürür ve şu değeri taşır: NOT_STARTED = 0 STARTED = 1 ASLEEP = 2 STOPPED = 3

Yol Parametreleri

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

200: OK

{'project_id': 1, 
'viber': [{
        'id': 14, 
        'uri': 'salebotstage', 
        'name': 'salebotstage', 
        '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': [] 
}

Botun şemasındaki blokların listesini alma

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

Yol Parametreleri

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

200: OK

{
    // Yanıt
}

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