Pieprasījumi tiek veikti ar metodi POST uz URL, t.i., https://chatter.mavibot.ai/api/{api\_key}/{action}

Kur tas atrodas: api_key ir atslēga API piekļuvei, kas tiek iegūta projekta iestatījumos:

Piekļuves atslēgu var iegūt, izmantojot mainīgo #{api_key}. Tas satur attiecīgo ģenerēto atslēgu. Neaizmirstiet to ģenerēt pirms lietošanas.

Kopējot vaicājuma URL no šīs lapas, tiek ievietota atstarpe, kas ir jāizdzēš, veicot izsaukumu

Piemērs saites kopēšanai nepareizā veidā: https://chatter.mavibot.ai/api/callback 

Atstarpi pēc .pro ir viegli nepamanīt, bet, ja tā paliek vietā, vaicājums nedarbosies

Nosūtot pieprasījumu ar GET metodi, neizmantojiet aizliegtus vārdus. Iepazīstieties ar pareizu GET pieprasījumu veidošanu

Kā saņemt ziņojumus uz Webhook URL, kas norādīts projekta iestatījumos

Projekta iestatījumi

Katrs ienākošais vai izejošais ziņojums tiek nosūtīts ar šādiem json POST pieprasījumiem:

{
    'id': ziņojuma identifikators sistēmā,
    'client': {
        'id': klienta identifikators sistēmā,
        'recepient': klienta identifikators kurjerā,
        'client_type': kurjera veids,
        'name': klienta vārds,
        'avatar': klienta attēls,
        'created_at': datums, kad klients tika izveidots,
        'tag': abonēšanas atslēga,
        'group': bots, kuram klients ir piesaistīts,
    },
    'message': ziņojuma teksts,
    'attachments': saites uz failiem masīvs,
    'message_id': bloka id, no kura ziņojums tika nosūtīts,
    'project_id': projekta id,
    'is_input': 1, ja ziņojums ir no klienta, 0, ja no bota,
    'delivered': 1, ja ziņojums ir veiksmīgi nosūtīts, 0, ja bija kļūda,
    'error_message': kļūdu izskaidrojošs ziņojums
}

Ja pieprasījums atgriezās ar kļūdu, tas netiks atkārtoti nosūtīts. Ja serveris atgriezās ar kļūdu, paziņojumi tomēr tiks saņemti.

Kā izmantot universālo webhook

Šīs metodes tagad var palaist gan ar POST, gan GET pieprasījumu.

Iepriekš parametri (ar kuriem tika palaistas klientu metodes, t.i., client_id) mūsu metodēs bija ļoti stingri uzrakstīti, un tas radīja dažus ierobežojumus, tos izmantojot ar trešo pušu pakalpojumiem.

Tagad jūs varat norādīt, kurā pieprasījuma parametrā Mavibot meklēs lietotāja identifikatoru: šim nolūkam tiek izmantots parametrs ar prefiksu value_, piemēram, value_user_id un value_group_id.

Arī metode atzvanīšanas nosūtīšanai callback var tikt palaista, pārsūtot e-pastu (client_email) un klienta tālruņa numuru (client_phone).

Metodes callback un whatsapp_callback nav piesaistītas parametru nosaukumiem. Jūs varat norādīt, kurš parametrs saturēs klienta tālruņa numuru, e-pastu un id.

Tas ir noderīgi, ja iestatāt webhook saņemšanu caur citu vietni.

Lai norādītu, kurš mainīgais satur client_id, jums jāpārsūta value_client_id un jāmin parametra nosaukums ar šo vērtību

Lai norādītu, kurš mainīgais satur tālruni, jums jāpārsūta value_phone un jāmin parametra nosaukums ar šo vērtību

Lai norādītu, kurš mainīgais satur e-pastu, jums jāpārsūta value_email un jāmin parametra nosaukums ar šo vērtību

Lai norādītu, kurš mainīgais satur user_id, jums jāpārsūta value_user_id un jāmin parametra nosaukums ar šo vērtību

Lai norādītu, kurš mainīgais satur group_id, jums jāpārsūta value_group_id un jāmin parametra nosaukums ar šo vērtību

Piemērs:

Ierakstiet adresē value_client_id = my_client

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

Vaicājums būs līdzvērtīgs zemāk esošajam vaicājumam:

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

Kā redzat, parametra nosaukums, kas satur nosaukumu, atšķiras ar prefiksu value_

Kā palaist botu

Bota palaišana

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

Metodi var izmantot, lai palaistu darbplūsmu klientam vai apstiprinātu darbību trešās puses pakalpojumā. Šis ziņojums nebūs redzams klientam.
Papildus pārsūtītie parametri tiek saglabāti mainīgajos.
Metodi atzvanīšanas nosūtīšanai tagad var ieslēgt, kopīgojot e-pastu (client_email) vai klienta tālruņa numuru (client_phone)

Ceļa parametri

Nosaukums Veids Apraksts
api_key string piekļuves pilnvara

Pieprasījuma pamatteksts

Nosaukums Veids Apraksts
client_phone string tālruņa numurs, pēc kura tiek atrasts klients
client_email string e-pasts, pēc kura tiek atrasts klients
client_id string klienta id redaktorā
message string ziņojuma teksts

**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)

Bota palaišana, izmantojot numuru WhatsApp

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

Šī metode palaiž botu WhatsApp pēc tam, kad klients reģistrējas vietnē vai atstāj pieprasījumu ar savu tālruņa numuru
Papildus pārsūtītie parametri tiek saglabāti mainīgajos

Ceļa parametri

Nosaukums Veids Apraksts
api_key string piekļuves pilnvara

Pieprasījuma pamatteksts

Nosaukums Veids Apraksts
name string klienta vārds
message string ziņojuma teksts
phone string klienta tālruņa numurs
bot_id string bota id

**200: OK **

{
    // Response
}

Bota palaišana, izmantojot Telegram id

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

Metodi var izmantot, lai palaistu darbplūsmu vai apstiprinātu darbības trešās puses vietnē. Šis ziņojums nebūs redzams klientam.

Papildus pārsūtītie parametri tiek saglabāti mainīgajos

Ceļa parametri

Nosaukums Veids Apraksts
api_key string piekļuves pilnvara

Pieprasījuma pamatteksts

Nosaukums Veids Apraksts
message string ziņojuma teksts
user_id string lietotāja id Telegram
group_id string bota nosaukums (jābeidzas ar bot)

**200: OK **

{
    // Response
}

Kā strādāt ar ziņojumiem

Parametri ziņojumu sūtīšanai

attachment_type var būt šādas vērtības: image, video, link, file, audio
Sūtot pielikumus, parametrs message nav obligāts

buttons identificē pogas, kas tiks pievienotas ziņojumam. Pogu formāts ir salīdzināms ar pogu papildu iestatījumiem. Ir iespējami divi pogu pārsūtīšanas varianti: viens ar rīka padomu kurjeros bez pogām un viens bez tā

Šeit ir pogu parametra piemērs:

"buttons": {"hint": "Šis teksts tiks parādīts WhatsApp",
 "buttons": [
    {"type": "reply", 
     "text": "Kādus pakalpojumus mēs varam sniegt", 
     "line": 0, "index_in_line": 0}, 
       
    {"type": "reply", 
     "text": "Maksājuma informācija", 
     "line": 0, 
     "index_in_line": 1}, 
        
    {"type": "reply", 
     "text": "Mūsu kontaktinformācija", 
     "line": 1, "index_in_line": 0}, 
        
    {"type": "reply", 
     "text": "Atstāt pieteikumu", 
     "line": 1, "index_in_line": 1}
   ] 
}

Ziņojuma nosūtīšana klientam

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

Šo metodi var izmantot, lai nosūtītu ziņojumus ar paziņojumiem. Parametrs message ir obligāts, ja nesūtāt failu. Ja sūtāt, tad teksts nav nepieciešams

Ceļa parametri

Nosaukums Veids Apraksts
api_key string piekļuves atslēga

Pieprasījuma pamatteksts

Nosaukums Veids Apraksts
message_id string sūtīšanas bloka numurs
message string ziņojuma teksts
client_id string klienta id redaktorā
attachment_type string faila attēlošanas veids
attachment_url string faila URL
buttons object pogas

**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)

Ziņojumu sūtīšana WhatsApp

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

Ļauj nosūtīt ziņojumu no pievienotā bota vārda uz norādīto numuru whatsapp_bot_id ir jāņem no sadaļas “Kurjeri un tērzēšana”. Katra pievienotā WhatsApp lapa saņem unikālu identifikāciju

Ceļa parametri

Nosaukums Veids Apraksts
api_key string piekļuves atslēga

Pieprasījuma pamatteksts

Nosaukums Veids Apraksts
message_id string sūtīšanas bloka numurs
whatsapp_bot_id number WhatsApp bots, kas sūta ziņojumu
attachment_url string faila url
attachment_type string faila attēlošanas veids
message string ziņojuma teksts
phone string saņēmēja tālruņa numurs

**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)

Ziņojumu sūtīšana lielapjomā

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

Metode ļauj izplatīt ziņojumus. Ja parametrs clients nav minēts, pārraide tiks nosūtīta visiem lietotājiem. Ir nepieciešams nosūtīt failu vai tekstu

Ceļa parametri

Nosaukums Tips Apraksts
api_key string piekļuves atslēga

Pieprasījuma pamatteksts

Nosaukums Tips Apraksts
message_id string sūtīšanas bloka numurs
list string saņēmēju numuru saraksts
shift string sekunžu skaits starp ziņojumiem. Pēc noklusējuma 0.2
message string ziņojuma teksts
clients array saņēmēju id
attachment_type string faila attēlošanas veids
attachment_url string faila URL
buttons string pogas

**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)

Ziņojumu vēstures iegūšana

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

Ziņojumu vēstures iegūšana. Parametru client_id var iegūt ŠEIT

Ceļa parametri

Nosaukums Tips Apraksts
api_key string piekļuves atslēga

Vaicājuma parametri

Nosaukums Tips Apraksts
client_id string klienta id

**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"
    },
  ]
}

Ziņojumu vēstures notīrīšana

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

Ceļa parametri

Nosaukums Tips Apraksts
api_key string piekļuves atslēga

Vaicājuma parametri

Nosaukums Tips Apraksts
client_id string klienta id

**200: OK **

import requests
import json


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

Kā izplatīt klientus

Klienta piešķiršana darbiniekam

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

Metode ļauj piešķirt klientu darbiniekam. E-pasta parametrs nav obligāts. Ja e-pasts nav norādīts, tas tiks izplatīts, izmantojot sistēmas algoritmu

Ceļa parametri

Nosaukums Tips Apraksts
api_key string piekļuves atslēga

Vaicājuma parametri

Nosaukums Tips Apraksts
client_id String klienta id
e-mail String darbinieka e-pasts (nav obligāts)

**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)

Klientu ielāde sistēmā

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

Metode ļauj ielādēt klientus sistēmā. Augšupielādējot WhatsApp klientus, numuru var pārsūtīt brīvi ar @s.whatsapp.net beigās vai bez tā.

Grupas id (group_id) var iegūt šeit caur /api/<api_key>/connected_channels

(ja client_type=13 (telefonija), tad group_id=””)

Var redzēt ziņojumapmaiņas veidu, no kura klients nāca (client_type)

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

Ceļa parametri

Nosaukums Tips Apraksts
api_key string piekļuves atslēga

Pieprasījuma pamatteksts

Nosaukums Tips Apraksts
platform_id String tālruņa numurs
group_id String grupas id
client_type String ziņojumapmaiņas veids, no kura klients nāca

**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)
# veiksmes gadījumā funkcija atgriež katram elementam tā id un pievienošanas statusu
# atbildes piemērs
# {"status":"success","items":[{"platform_id":"[email protected]","group_id":"5kqchxwyvdvFZOsp80q2qw==","client_type":6,"status":"success","id":1469409}]}

Klientu pievienošana sarakstam

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

Ceļa parametri

Nosaukums Tips Apraksts
api_key string piekļuves atslēga

Pieprasījuma pamatteksts

Nosaukums Tips Apraksts
list_id integer saraksta numurs
clients array klientu numuru masīvs

**200: OK **

{
    // Atbilde
}

Klientu noņemšana no saraksta

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

Ceļa parametri

Nosaukums Tips Apraksts
api_key string piekļuves atslēga

Pieprasījuma pamatteksts

Nosaukums Tips Apraksts
list_id integer saraksta numurs
clients array klientu numuru masīvs

**200: OK **

{
    // Atbilde
}

Klientu saraksta iegūšana

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

Ceļa parametri

Nosaukums Tips Apraksts
api_key string piekļuves atslēga

Vaicājuma parametri

Nosaukums Tips Apraksts
offset string nobīde no pirmā elementa
limit integer elementu skaits atbildē. Pēc noklusējuma 500, maks. 500
list string saraksta numurs

200: OK Atgriež elementu statusu un masīvu

{
"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
    }
]
}

Abonentu saraksta iegūšana jebkurā ziņojumapmaiņas lietotnē

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

Informācijas iegūšana par klientiem izvēlētajā ziņojumapmaiņas lietotnē

Ceļa parametri

Nosaukums Tips Apraksts
api_key string piekļuves atslēga

Vaicājuma parametri

Nosaukums Tips Apraksts
page integer
tag string atzīme, kas tika minēta abonēšanas lapā
group integer grupas id, kurai abonents ir piesaistīts
date_from integer laikspiedols datumam, pēc kura viņi abonēja
date_to integer laikspiedols datumam, līdz kuram viņi abonēja
client_type integer ziņojumapmaiņas lietotnes id, kurai nepieciešams abonēšanas saraksts. ja neko nemaina, tiek parādīti visi klienti

**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"
    }
  }
]

Atļauja dzēst klientus

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

Piekļuves atļauja, ģenerējot atslēgu: “Atļauja dzēst klientus”

Parametri

Ceļš
ap_key* — piekļuves marķieris

Pamatteksts
client_ids — dzēšamo klientu ID saraksts. Maksimums 500. Piemērs: [199571, 199707, 1935722]

Kā strādāt ar mainīgajiem

Mainīgo atribūtu piešķiršana

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

Ļauj saglabāt mainīgos lietojumprogrammā un klientā.
Pieprasījums par mainīgo atribūtu piešķiršanu pēc noklusējuma pievieno darījuma mainīgajiem.
Ja nepieciešams mainīt mainīgos profilā, jāpievieno prefikss client.
Piem. mobilajam: client.phone

Parametrs clients ļauj piešķirt mainīgos lielapjomā

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

Ceļa parametri

Nosaukums Tips Apraksts
api_key string piekļuves atslēga

Pieprasījuma pamatteksts

Nosaukums Tips Apraksts
clients array klientu id masīvs mainīgo piešķiršanai
client_id string klienta id
variables object mainīgo hash (atslēgas vērtība)

**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)

Mainīgo iegūšana

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

Ceļa parametri

Nosaukums Tips Apraksts
api_key string piekļuves marķieris

Vaicājuma parametri

Nosaukums Tips Apraksts
client_id string klienta id

**200: OK **

import requests
import json


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

Kā iegūt client_id

Klienta ID iegūšana pēc platformas ID vērtības

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

Metode atgriež klienta ID API pieprasījumu izpildei

Parametru piemērs: {"platform_ids": ["571830542", "256865200"]}

Ceļa parametri

Nosaukums Veids Apraksts
string piekļuves atslēga

Pieprasījuma pamatteksts

Nosaukums Veids Apraksts
platform_ids string ID masīvs kurjerā

**200: OK **

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

Kā iegūt klienta ID tiešsaistes tērzēšanā

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

Šī metode ļauj integrēt vietni un tērzēšanas robotu, t.i., ja persona ir iegājusi lapā ar īpašo piedāvājumu, jūs varat nekavējoties nosūtīt ziņojumu par piedāvājumu tērzēšanā

Ceļa parametri

Nosaukums Veids Apraksts
api_key string piekļuves marķieris

Vaicājuma parametri

Nosaukums Veids Apraksts
tag string klienta birka
name string klienta vārds
recipient string dialoga ID vietnē

**200: OK **

{ "client_id": 36553 }

Kur iegūt recipient? Vietnē, kurā ir tiešsaistes tērzēšana “Mavibot.ai”, jums ir jāiegūst funkcija MaviBotPro.recipient_id, izmantojot JS.

Kā iegūt klienta ID ar WhatsApp numuru

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

Metode atgriež klienta ID API pieprasījumu izpildei, ja zināt klienta tālruņa numuru WhatsApp.
Ja šāda klienta ar šo numuru nav, jūs saņemsiet 404.

Ceļa parametri

Nosaukums Veids Apraksts
api_key string piekļuves marķieris

Vaicājuma parametri

Nosaukums Veids Apraksts
phone string tālruņa numurs

**200: OK **

{
    // Atbilde
}

Klienta ID iegūšana ar tālruņa numuru

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

Metode atgriež klienta ID API pieprasījumu izpildei.
Meklēšana notiek caur WhatsApp klientiem, kā arī caur mainīgajiem.

Ceļa parametri

Nosaukums Veids Apraksts
api_key string piekļuves marķieris

Vaicājuma parametri

Nosaukums Veids Apraksts
phone string tālruņa numurs

**200: OK **

{
    // Atbilde
}

Klienta ID iegūšana, izmantojot e-pastu

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

Metode atgriež klienta ID API pieprasījumu izpildei. Meklēšana notiek caur mainīgajiem.

Ceļa parametri

Nosaukums Veids Apraksts
api_key string piekļuves marķieris

Vaicājuma parametri

Nosaukums Veids Apraksts
email string e-pasts meklēšanai

**200: OK **

{
    // Atbilde
}

Klienta ID iegūšana pēc mainīgā vērtības

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

Metode atgriež klienta ID API pieprasījumu izpildei

Ceļa parametri

Nosaukums Veids Apraksts
api_key string piekļuves marķieris

Vaicājuma parametri

Nosaukums Veids Apraksts
var string mainīgā nosaukums, pēc kura tiks veikta meklēšana
val string mainīgā vērtība

**200: OK **

{
    // Atbilde
}

Kādas vēl iespējas pastāv

Darījuma pārvietošana uz MavibotCRM stāvokli

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

Darījuma numuru var iegūt MavibotCRM darbplūsmas rediģēšanas logā.

Ceļa parametri

Nosaukums Veids Apraksts
api_key string piekļuves atslēga

Pieprasījuma pamatteksts

Nosaukums Veids Apraksts
client_id string klienta ID
state_id string stāvokļa numurs, uz kuru pārvietot klienta darījumu

**200: OK **

{
    // Atbilde
}

Pārbaude, vai persona seko Instagram kontam

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

Var izsaukt gan ar POST metodi, gan ar GET metodi

Ceļa parametri

Nosaukums Veids Apraksts
api_key string piekļuves atslēga

Pieprasījuma pamatteksts

Nosaukums Veids Apraksts
user_name string tā klienta lietotājvārds, kuru vēlaties pārbaudīt
login string pārbaudāmā robota pieteikšanās vārds

200: OK Lauks is_follower satur informāciju par to, vai persona tam seko

{
"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
}

Pārbaude, vai tālruņa numurs izmanto WhatsApp

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

Lai izmantotu metodi, JUMS IR jābūt savienotam WhatsApp un Mavibot

Var izsaukt gan ar POST metodi, gan ar GET metodi
Tālruņa numuru var nodot jebkurā formātā

Ceļa parametri

Nosaukums Veids Apraksts
api_key string piekļuves marķieris

Pieprasījuma pamatteksts

Nosaukums Veids Apraksts
phone string tālruņa numurs

**200: OK **

{
    // Atbilde
}

Projektam pievienoto kurjeru saraksta iegūšana (ieskaitot group_id)

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

Funkcija atgriež parametru group_id katram kurjeram, un tas ir jānodod, ielādējot klientus

Lauks status tiek atgriezts arī WhatsApp, un tajā ir vērtība:
NOT_STARTED = 0
STARTED = 1
ASLEEP = 2
STOPPED = 3

Ceļa parametri

Nosaukums Veids Apraksts
api_key string piekļuves marķieris

**200: OK **

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

Bloku saraksta iegūšana no robota shēmas

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

Ceļa parametri

Nosaukums Veids Apraksts
api_key string piekļuves marķieris

**200: OK **

{
    // Atbilde
}

Ja jums ir nepieciešamas papildu metodes, lūdzu, sazinieties ar klientu atbalstu