API veidotājs

URL pieprasījums: https://chatter.mavibot.ai/api/#{api\_key}/callback

Šo metodi var izmantot, lai aktivizētu piltuvi klientam vai apstiprinātu darbību ārējā resursā. Klients šo ziņojumu neredzēs.

Lūdzu, ņemiet vērā: visi papildu parametri, ko nododat, tiks saglabāti mainīgajā

Atzvanīšanas metodi tagad var aktivizēt arī, izmantojot klienta e-pastu (client_email) vai tālruņa numuru (client_phone).

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt/dzēst klienta informāciju".

Ceļš

api key* - piekļuves marķieris

Pamatteksts

client_phone - tālruņa numurs, ko izmanto klienta meklēšanai

client_email - e-pasts, ko izmanto klienta meklēšanai

client_id - klienta ID veidotājā

message - ziņojuma teksts

resume_bot - True (neobligāts parametrs). Ja bots ir apturēts, to izmanto, lai to atsāktu.

Piemērs: resume_bot = True

time_shift - skaitlis. Ja norādīts, ziņojums tiks nosūtīts pēc noteikta sekunžu skaita no pašreizējā laika.

send_time - datums un laiks formātā "%Y-%m-%d %H:%M:%S" (piemēram, "2024-10-16 13:15:59"). Tas nosaka datumu un laiku ziņojuma nosūtīšanai. Ja ir norādīti gan time_shift, gan send_time, priekšroka tiks dota time_shift.

import requests
import json

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

URL pieprasījums: https://chatter.mavibot.ai/api/\\<api_key>/whatsapp_callback

Šī metode var aktivizēt WhatsApp robotu pēc tam, kad klients reģistrējas vietnē vai iesniedz pieprasījumu ar savu tālruņa numuru.

Lūdzu, ņemiet vērā: visi papildu parametri, ko nododat, tiks saglabāti mainīgajā

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt vai dzēst klienta informāciju".

Ceļš

api key* - piekļuves pilnvara

Virsraksts

name - klienta vārds
message - ziņojuma teksts
phone - klienta tālruņa numurs
bot_id - robota ID
resume_bot - True (neobligāts parametrs). Ja robots ir apturēts, izmantojiet šo, lai to atsāktu. Piemērs: resume_bot = True

time_shift - skaitlis. Ja norādīts, ziņojums tiks nosūtīts pēc noteikta sekunžu skaita no pašreizējā laika.

send_time - datums un laiks formātā "%Y-%m-%d %H:%M:%S" (piemēram, "2024-10-16 13:15:59"). Tas nosaka datumu un laiku ziņojuma nosūtīšanai. Ja ir norādīti gan time_shift, gan send_time, priekšroka tiks dota time_shift.

URL pieprasījums: https://chatter.mavibot.pro/api/#{api\\_key}/tg\\_callback

Šo metodi var izmantot, lai aktivizētu piltuvi klientam vai apstiprinātu darbību ārējā vietnē. Klients šo ziņojumu neredzēs.

Lūdzu, ņemiet vērā: visi papildu parametri, ko nododat, tiks saglabāti mainīgajos.

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt vai dzēst klienta informāciju".

Ceļš

api key* - piekļuves pilnvara

Virsraksts

message - ziņojuma teksts
user_id - Telegram lietotāja ID
group_id - robota nosaukums (beidzas ar bot)
resume_bot - True (neobligāts parametrs). Ja robots ir apturēts, izmantojiet šo, lai to atsāktu. Piemērs: resume_bot = True

time_shift - skaitlis. Ja norādīts, ziņojums tiks nosūtīts pēc noteikta sekunžu skaita no pašreizējā laika.

send_time - datums un laiks formātā "%Y-%m-%d %H:%M:%S" (piemēram, "2024-10-16 13:15:59"). Tas nosaka datumu un laiku ziņojuma nosūtīšanai. Ja ir norādīti gan time_shift, gan send_time, priekšroka tiks dota time_shift.

URL pieprasījums: https://chatter.mavibot.ai/api/#{api\\_key}/send\\_callback\\_by\\_platform\\_id

Kad projektā tiek atrasti klienti ar platform_id no saraksta, tiks nosūtīts atgriezeniskās saites ziņojums ar tekstu no callback_text lauka.
Ierobežojums: 1 pieprasījums = maksimāli 300 sūtījumi

Pieprasījuma parametru piemērs:
{"platform_ids":[407184121, "79609879898", "2rwewefw"], "callback_text": "test_callback"}

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt vai dzēst klienta informāciju".

Ceļš

api key* - piekļuves pilnvara

Virsraksts

platform_ids - klientu ID saraksts kurjerā
callback_text - atgriezeniskās saites teksts
group_id - robota ID

time_shift - skaitlis. Ja norādīts, ziņojums tiks nosūtīts pēc noteikta sekunžu skaita no pašreizējā laika.

send_time - datums un laiks formātā "%Y-%m-%d %H:%M:%S" (piemēram, "2024-10-16 13:15:59"). Tas nosaka datumu un laiku ziņojuma nosūtīšanai. Ja ir norādīti gan time_shift, gan send_time, priekšroka tiks dota time_shift.

URL pieprasījums: https://chatter.mavibot.ai/api/#{api\\_key}/email\\_callback

Šī metode var aktivizēt e-pasta robotu pēc tam, kad klients reģistrējas vietnē vai iesniedz pieprasījumu ar savu e-pastu. Metode atradīs klienta e-pastu vai izveidos to, ja tas netiks atrasts.

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt vai dzēst klienta informāciju".

Lūdzu, ņemiet vērā: visi papildu parametri, ko nododat, tiks saglabāti mainīgajā

Ceļš

api key* - piekļuves pilnvara

Virsraksts

name - klienta vārds
message - ziņojuma teksts
email - e-pasta adrese
email_id_bot - robota e-pasta adrese
resume_bot - True (neobligāts parametrs).

Ja robots ir apturēts, izmantojiet šo, lai to atsāktu. Piemērs: resume_bot = True

time_shift - skaitlis. Ja norādīts, ziņojums tiks nosūtīts pēc noteikta sekunžu skaita no pašreizējā laika.

send_time - datums un laiks formātā "%Y-%m-%d %H:%M:%S" (piemēram, "2024-10-16 13:15:59"). Tas nosaka datumu un laiku ziņojuma nosūtīšanai. Ja ir norādīti gan time_shift, gan send_time, priekšroka tiks dota time_shift.

URL pieprasījums: https://chatter.mavibot.ai/api/#{api\\_key}/message

Šo metodi var izmantot, lai nosūtītu paziņojumu ziņojumus. Ziņojuma parametrs ir obligāts, ja vien nesūtāt failu. Ja sūtāt failu, teksts nav obligāts.

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt vai dzēst klienta informāciju".

Ceļš

api key* - piekļuves pilnvara

Virsraksts

message_id - bloka numurs sūtīšanai
message - ziņojuma teksts
client_id - klienta ID veidotājā
attachment_type - faila attēlošanas veids. Obligāts, ja ir norādīts attachment_url.
attachment_url - faila URL
buttons - pogas

time_shift - skaitlis. Ja norādīts, ziņojums tiks nosūtīts pēc noteikta sekunžu skaita no pašreizējā laika.

send_time - datums un laiks formātā "%Y-%m-%d %H:%M:%S" (piemēram, "2024-10-16 13:15:59"). Tas nosaka datumu un laiku ziņojuma nosūtīšanai. Ja ir norādīti gan time_shift, gan send_time, priekšroka tiks dota time_shift.

import requests
import json

# Teksta ziņojuma nosūtīšana
params = {"message": "some_text", "client_id": "25554"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/message'
requests.post(url, json=params)

# Pielikuma nosūtīšana
params = {
    "message": "some message",
    "client_id": "1234565",
    "attachment_type": "video/image/file",
    "attachment_url": "https://qwreqw"
}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/message'
requests.post(url, json=params)

# 'attachment_type' norādiet 'video', 'image' vai 'file'
# atkarībā no pielikuma veida: video, attēls vai dokuments.

URL pieprasījums: https://chatter.mavibot.pro/api/\\<api_key>/whatsapp_message

Ļauj nosūtīt ziņojumu pievienotā robota vārdā uz norādīto numuru. whatsapp_bot_id ir jāņem no sadaļas "Kurjeri un tērzēšanas". Katram pievienotajam WhatsApp kontam veidotājs piešķir unikālu identifikatoru.

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt vai dzēst klienta informāciju".

Ceļš

api key* - piekļuves pilnvara

Virsraksts

message_id - bloka numurs sūtīšanai
whatsapp_bot_id - WhatsApp robota ID, no kura jānosūta ziņojums
attachment_url - faila URL
attachment_type - faila attēlošanas veids. Obligāts, ja ir norādīts attachment_url.
message - ziņojuma teksts
phone - saņēmēja tālruņa numurs

time_shift - skaitlis. Ja norādīts, ziņojums tiks nosūtīts pēc noteikta sekunžu skaita no pašreizējā laika.

send_time - datums un laiks formātā "%Y-%m-%d %H:%M:%S" (piemēram, "2024-10-16 13:15:59"). Tas nosaka datumu un laiku ziņojuma nosūtīšanai. Ja ir norādīti gan time_shift, gan send_time, priekšroka tiks dota time_shift.

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)

URL pieprasījums: https://chatter.mavibot.ai/api/#{api\\_key}/broadcast

Šī metode ļauj sākt apraidi.

Varat izmantot vienu no šīm savstarpēji izslēdzošajām iespējām:

1. list parametrs — apraide tiks nosūtīta norādītajam klientu sarakstam.
2. clients parametrs — apraide tiks nosūtīta klientu ID masīvam.
3. platform_ids un group_id parametri — apraide tiks nosūtīta platform_ids (kurjeru ID) masīvam norādītajam robotam (group_id).
4. Ja neviens no iepriekš minētajiem parametriem nav norādīts, apraide netiks nosūtīta.

Obligātie parametri: message (un/vai attachment_type un attachment_url) vai message_id.

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt vai dzēst klienta informāciju".

Ceļš

api key* - piekļuves pilnvara

Virsraksts

list - saraksta numurs, uz kuru jānosūta apraide

clients - klientu ID veidotājā

message - ziņojuma teksts

platform_ids - saņēmēju ID kurjerā. Jāizmanto kopā ar obligāto group_id parametru

group_id - obligāts tikai tad, ja tiek izmantoti platform_ids. Ignorēts ar citām iespējām. Norāda robotu sūtīšanai uz dotajiem platform_ids

attachment_url - faila URL

attachment_type - faila attēlošanas veids. Obligāts, ja ir norādīts attachment_url.

buttons - pogas

message_id - bloka numurs sūtīšanai

shift — sekunžu skaits starp ziņojumiem. Noklusējums ir 0,2.

time_shift - skaitlis. Ja norādīts, ziņojums tiks nosūtīts pēc noteikta sekunžu skaita no pašreizējā laika.

send_time - datums un laiks formātā "%Y-%m-%d %H:%M:%S" (piemēram, "2024-10-16 13:15:59"). Tas nosaka datumu un laiku ziņojuma nosūtīšanai. Ja ir norādīti gan time_shift, gan send_time, priekšroka tiks dota time_shift.

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)

URL pieprasījums: https://chatter.mavibot.ai/api/#{api\_key}/get\_history?client\_id=

Parametru client_id var iegūt šeit. saite

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja lasīt klienta informāciju".

Ceļš

api key* - piekļuves marķieris

Virsraksts

client_id - klienta ID

limit - vienumu skaits atbildē. Noklusējums: 2000, maksimums: 2000

start_date - atlases perioda sākuma datums (obligāts, ja norādīts stop_date), formāts: dd.mm.yyyy

stop_date - atlases perioda beigu datums (obligāts, ja norādīts start_date), formāts: dd.mm.yyyy

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

URL pieprasījums: https://chatter.mavibot.ai/api/#{api\_key}/clear\_history?client\_id=

Dzēš tērzēšanas vēsturi

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt/dzēst klienta informāciju".

Ceļš

api key* - piekļuves marķieris

Virsraksts

client_id - klienta ID

import requests
import json


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

URL pieprasījums: 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, sistēma piešķirs klientu saskaņā ar savu algoritmu.

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt/dzēst klienta informāciju".

Ceļš

api key* - piekļuves marķieris

Virsraksts

client_id - klienta ID
email - darbinieka e-pasts (nav obligāts)

import requests
import json

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

URL pieprasījums: https://chatter.mavibot.pro/api/#{api\_key}/load\_clients

Šī metode ļauj importēt klientus sistēmā. Augšupielādējot WhatsApp klientus, numuru var norādīt jebkurā formātā, ar beigu daļu @s.whatsapp.net vai bez tās.

Grupas ID (group_id) var iegūt ŠEIT, izmantojot /api/<api_key>/connected_channels. (Ja client_type = 13 (telefonija), tad group_id ir tukša virkne: ""). saite

Ziņojumapmaiņas veidu, no kura klients nācis (client_type), var atrast ŠEIT. saite

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

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt vai dzēst klienta informāciju".

Ceļš

api key* - piekļuves marķieris

Virsraksts

platform_id - tālruņa numurs
group_id - grupas ID
client_type - ziņojumapmaiņas veids, no kura klients nācis

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)
# ja veiksmīgi, funkcija atgriezīs ID un pievienošanas statusu katram vienumam
# atbildes piemērs
# {"status":"success","items":[{"platform_id":"[email protected]","group_id":"5kqchxwyvdvFZOsp80q2qw==","client_type":6,"status":"success","id":1469409}]}

URL pieprasījums: https://chatter.mavibot.ai/api/\<api_key>/add_to_list

Pievieno klientus sarakstam

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt vai dzēst klienta informāciju".

Ceļš

api key* - piekļuves marķieris

Virsraksts

list_id - saraksta numurs
clients - klienta ID masīvs

Piemērs:
JSON parametri
{"list_id":1170282, "clients":[411262772, 646410963]}

URL pieprasījums: https://chatter.mavibot.ai/api/#{api\_key}/remove\_from\_list

Noņem klientus no saraksta

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt vai dzēst klienta informāciju".

Ceļš

api key* - piekļuves marķieris

Virsraksts

list_id - saraksta numurs
clients - klientu numuru masīvs Mavibot veidotājā (client_id vērtības)

URL pieprasījums: https://chatter.mavibot.a/aipi/\<api_key>/get_clients

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt vai dzēst klienta informāciju".

Ceļš

api key* - piekļuves marķieris

Virsraksts

offset – Nobīde no pirmā elementa

limit – Vienumu skaits atbildē / Noklusējums: 500, Maksimums: 500

list – Saraksta numurs

reverse – Norāda apgriezto šķirošanu (no vecākā ieraksta uz jaunāko). Šis parametrs darbojas tikai tad, ja saraksts nav norādīts.

Atgriež statusu un vienumu 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
    }
]
}

URL pieprasījums: https://chatter.mavibot.ai/api/#{api\_key}/subscribers

Iegūst klienta informāciju no izvēlētā ziņojumapmaiņas veida.

Piezīme! Šī metode neatgriež mainīgos.

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt vai dzēst klienta informāciju".

Ceļš

api key* - piekļuves marķieris

Virsraksts

page
tag – Abonēšanas lapā norādītā birka
group – VK grupas ID, ar kuru abonents ir saistīts
date_from – Abonēts pēc šī datuma (laikspiedols)
date_to – Abonēts pirms šī datuma (laikspiedols)
client_type – Ziņojumapmaiņas veida ID, kuram iegūt abonentu sarakstu. Ja nav norādīts, tiks atgriezti visi klienti

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

URL pieprasījums: https://chatter.mavibot.ai/api/#{api\_key}/save\_variables

!** **Šim pieprasījumam nav ierobežojumu.

Ļauj saglabāt mainīgos gan potenciālajā klientā, gan klientā.
Pēc noklusējuma mainīgo piešķiršanas pieprasījums tos pievieno darījuma mainīgajiem.
Lai atjauninātu mainīgos klienta profilā, izmantojiet priedēkli client. Piemēram, tālrunim: client.phone.

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt vai dzēst klienta informāciju".

Atjauninājums: Parametrs clients ļauj piešķirt mainīgos lielapjomā.
Piemērs: {"client_id":49177759, "variables":{"client.phone":"88888888888"}}

Ceļš

api key* - piekļuves marķieris

Virsraksts

clients – Klientu ID masīvs mainīgo piešķiršanai

client_id – Klienta ID

variables – Mainīgo jaucējkoks (atslēgas-vērtības pāri)

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)

URL pieprasījums: https://chatter.mavibot.ai/api/#{api\_key}/get\_variables?client\_id=

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt vai dzēst klienta informāciju".

Piemērs: https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/get\_variables?client\_id=49177759

Ceļš

api key* - piekļuves marķieris

Virsraksts

client_id - klienta ID

import requests
import json


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

URL pieprasījums: https://chatter.mavibot.ai/api/#{api\_key}/find\_client\_id\_by\_platform\_id

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt vai dzēst klienta informāciju".

Ceļš

api key* - piekļuves marķieris

Virsraksts

platform_ids - ID masīvs ziņojumapmaiņas platformā
group_id - bota ID

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

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

URL pieprasījums: https://chatter.mavibot.ai/api/#{api\_key}/online\_chat\_client\_id?recipient=

Šī metode ļauj integrēt vietni ar tērzēšanas robotu. Piemēram, ja lietotājs apmeklē akcijas lapu, jūs varat nekavējoties nosūtīt ziņojumu tērzēšanā ar personalizētu piedāvājumu.

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt vai dzēst klienta informāciju".

Ceļš

api atslēga* - piekļuves marķieris

Virsraksts

tags - tags (klienta tags)
name - klienta vārds
recipient - dialoga ID tīmekļa vietnē

Kur iegūt recipient?

To var iegūt tīmekļa vietnē ar Mavibot.ai tiešsaistes tērzēšanu, izmantojot JavaScript, lai iegūtu rekvizītu MavibotAi.recipient_id.

{ "client_id": 36553 }

URL pieprasījums: https://chatter.mavibot.ai/api/#{api\_key}/whatsapp\_client\_id?phone=

Šī metode atgriež klienta ID API pieprasījumu veikšanai, ja zināt klienta WhatsApp tālruņa numuru.
Ja klients ar šo numuru neeksistē, metode atgriezīs 404 kļūdu.

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt vai dzēst klienta informāciju".

Ceļš

api atslēga* - piekļuves marķieris

Virsraksts

phone - tālruņa numurs
group_id - bota ID

URL pieprasījums: https://chatter.mavibot.ai/api/\<api_key>/find_client_id_by_phone?phone=

Šī metode atgriež klienta ID API pieprasījumu veikšanai.

Meklēšana tiek veikta gan starp WhatsApp klientiem, gan izmantojot mainīgos.

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt vai dzēst klienta informāciju".

Ceļš

api atslēga* - piekļuves marķieris

Virsraksts

phone - tālruņa numurs

URL pieprasījums: https://chatter.mavibot.ai/api/#{api\_key}/find\_client\_id\_by\_email?email=&#x20;

Šī metode atgriež klienta ID API pieprasījumu veikšanai.
Meklēšana tiek veikta, izmantojot mainīgos.

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt vai dzēst klienta informāciju".

Ceļš

api atslēga* - piekļuves marķieris

Virsraksts

email - e-pasts meklēšanai

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

Šī metode atgriež klienta ID API pieprasījumu veikšanai.

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja lasīt klienta informāciju"

Ceļš

api atslēga* - piekļuves marķieris

Virsraksts

var - mainīgā nosaukums, pēc kura meklēt
val - mainīgā vērtība
group_id - grupas ID
search_in - nododiet vērtību 'order', lai meklētu darījuma mainīgajos; meklē līdz trim mainīgajiem projekta klientiem un atgriež to klientu sarakstu, kuriem ir visi norādītie mainīgie.

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

Šī metode atgriež jaunākā izveidotā klienta ID API pieprasījumu veikšanai. Tā meklē gan klienta, gan darījuma mainīgajos.

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja lasīt klienta informāciju"

Ceļš

api atslēga* - piekļuves marķieris

Virsraksts

var - mainīgā nosaukums, pēc kura meklēt
val - mainīgā vērtība

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

Šī metode atgriež to klientu ID sarakstu, kuriem ir norādītais mainīgais ar norādīto vērtību.

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja lasīt klienta informāciju"

Ceļš

api atslēga* - piekļuves marķieris

Virsraksts

var - mainīgā nosaukums, pēc kura meklēt
val - mainīgā vērtība

{
    // Atbilde
}

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

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja lasīt klienta informāciju".

Ceļš

api atslēga* - piekļuves marķieris

Virsraksts

mainīgais1 - Vērtība1

mainīgais2 - Vērtība2

mainīgais3 - Vērtība3

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

URL pieprasījums: https://chatter.mavibot.ai/api/#{api\_key}/find\_clients

Šī metode meklē pēc mainīgajiem un atgriež to klientu ID sarakstu, kuri atbilst vaicājuma nosacījumiem.

Pēc noklusējuma meklēšana tiek veikta klienta mainīgajos (ieteicams): {"q": {"result": "ok", "var": "home", "var": "60"}} – klientam ir jābūt visiem norādītajiem mainīgajiem

Meklēšana darījuma mainīgajos, jābūt vismaz vienam no norādītajiem mainīgajiem: {"q": {"result": "ok", "var": "home", "var": "60"}, "search_in": "order", "include_all": False}

Klienta mainīgā nosaukums ir vienāds ar vienu no saraksta vērtībām: {"q": {"name": {"_in": ["Joe", "Jane", "Donald"]}}}

Klienta mainīgā nosaukums NAV vienāds ar kādu no saraksta vērtībām: {"q": {"name": {"_not_in": ["Joe", "Jane", "Donald"]}}}

Klienta mainīgā nosaukums nav vienāds ar "Joe": {"q": {"name": {"_not": "Joe"}}}

Piezīme: Skaitļu salīdzināšana darbojas tikai tad, ja visiem klientiem meklētajā mainīgajā ir skaitliskas vērtības. Ja pat vienam klientam ir virkne, pieprasījums neizdosies.

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja lasīt klienta informāciju"

Parametri

Ceļš

api atslēga* - piekļuves marķieris

Virsraksts

q – obligāts parametrs, satur vaicājuma nosacījumus mainīgo meklēšanai

search_in – norāda, kuras entītijas mainīgos meklēt; ja nav norādīts, meklēšana tiek veikta klienta mainīgajos. Var būt vērtība order.

include_all – vai visiem q nosacījumiem ir jābūt izpildītiem;

False – ja atbilst vismaz viens nosacījums, entītija tiek atlasīta

Veiksme
{"status":"success","client_ids":[41203, 5622354, 785212]} 
{"status":"success","client_ids":[]} 
{"status": "fail", "message": "Parameter "q" required"} {"status": "fail", "message": "Error in parameter format"}
Kļūda
{"status":"fail","message":"Something went wrong"}

URL pieprasījums: https://chatter.mavibot.ai/api/#{api\_key}/get\_current\_order\_id

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja lasīt CRM informāciju".

Ceļš

api atslēga* - piekļuves marķieris

Virsraksts

client_id - klienta ID

Veiksmīga atbilde: {"status":"success","order_id":40632}, kur
order_id - pašreizējā darījuma ID
Kļūdas atbilde: {"status":"client_not_found"}

URL pieprasījums: https://chatter.mavibot.ai/api/#{api\_key}/get\_orders

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja lasīt CRM informāciju"

Ceļš

api atslēga* - piekļuves marķieris

Virsraksts

client_id - klienta ID

order_status - darījuma posms:
0 - aktīvi darījumi
1 - veiksmīgi darījumi
2 - neveiksmīgi darījumi

Veiksmīga atbilde: {"status":"success","order_id":[40338,40340,40341]} 
Kļūdas atbilde: {"status":"client_not_found"}

URL pieprasījums: https://chatter.mavibot.ai/api/#{api\_key}/move\_order\_to\_next\_state

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt/dzēst CRM informāciju"

Ceļš

api atslēga* - piekļuves marķieris

Virsraksts

client_id - klienta ID

order_id - darījuma ID

Veiksmīga atbilde: 
{"status":"success","state_id":37}, kur 
state_id - posma ID MavibotCRM 
Kļūdas atbilde: 
{"status":"client_not_found"}

URL pieprasījums: https://chatter.mavibot.ai/api/#{api\_key}/get\_order\_vars

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja lasīt CRM informāciju"

Ceļš

api atslēga* - piekļuves marķieris

Virsraksts

client_id - klienta ID

order_id - darījuma ID

variables - mainīgo masīvs
(formāts:["var_name1", "var_name2"])

Veiksmīga atbilde: 
{"status":"success","result":{"var_name1":"111","var_name2":"13.04.2023"}} 

Kļūdas piemērs: 
{"status":"client_not_found"}

URL pieprasījums: https://chatter.mavibot.ai/api/#{api\_key}/set\_order\_vars

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt/dzēst CRM informāciju"

Ceļš

api atslēga* - piekļuves marķieris

Virsraksts

client_id - klienta ID

order_id - darījuma ID

variables - mainīgo vārdnīca (atslēga ir mainīgā nosaukums, un vērtība ir tas, kas jāsaglabā šajā mainīgajā)
(formāts:{"var_name": "var_value"})

Veiksmīga atbilde: {"status":"success"} 
Kļūdas atbilde: {"status":"order 12345 not found"}

URL pieprasījums: https://chatter.mavibot.ai/api/#{api\_key}/create\_order

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt/dzēst CRM informāciju"

Ceļš

api atslēga* - piekļuves marķieris

Virsraksts

client_id - klienta ID

name - darījuma nosaukums

description - darījuma apraksts

budget - darījuma summa

Pieprasījumā jānorāda viens no šiem parametriem: client_id, email vai phone.
Ja ir norādīti vairāki parametri, tiks izmantots tikai viens. Prioritātes secība ir: client_id > phone > email.
Ja ir norādīts phone vai email un klients ar šo tālruņa numuru vai e-pastu neeksistē, tiks izveidots jauns klients.

Veiksmīga atbilde: {"status":"success","order_id":40654}, 
kur order_id ir jaunā aktīvā darījuma ID.
Kļūdas atbilde: {"status":"client_not_found"}

Pārvietot darījumu uz posmu MavibotCRM

**POST** https://chatter.mavibot.ai/api/#{api_key}/set_order_state

URL pieprasījums: https://chatter.mavibot.ai/api/#{api\_key}/set\_order\_state

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt/dzēst CRM informāciju"

Ceļš

api key* - piekļuves marķieris

Virsraksts

client_id - klienta ID

state_id - posma numurs, uz kuru jāpārvieto klienta darījums

Iegūt piltuves posma ID Mavibot CRM

**GET** https://chatter.mavibot.ai/api/#{api_key}/get_order_state

URL pieprasījums: https://chatter.mavibot.ai/api/#{api\_key}/get\_order\_state

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja lasīt CRM informāciju"

Ceļš

api key* - piekļuves marķieris

Virsraksts

client_id - klienta ID

state_id - darījuma ID (ja nav norādīts, metode atgriezīs pašreizējā darījuma posma ID)

Veiksmīgas atbildes piemērs:
{'status': 'success', 'state_id': 123456}

Neveiksmīgas atbildes piemērs:
{'status': 'order not found'}

Kādas vēl iespējas ir pieejamas?

Pārbaudīt, vai tālruņa numuram ir WhatsApp

**GET** https://chatter.mavibot.ai/api/#{api_key}/check_whatsapp

URL pieprasījums: https://chatter.mavibot.ai/api/#{api\_key}/check\_whatsapp

Lai izmantotu šo metodi, WhatsApp ir jābūt savienotam ar Mavibot.

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt vai dzēst klienta informāciju".

Var izsaukt, izmantojot GET vai POST.
Tālruņa numuru var norādīt jebkurā formātā.

Ceļš

api key* - piekļuves marķieris

Virsraksts

phone - pārbaudāmais tālruņa numurs

Iegūt projektam pievienoto kurjeru sarakstu

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

URL pieprasījums: https://chatter.mavibot.ai/api/\<api_key>/connected_channels

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt vai dzēst klienta informāciju".

Funkcija atgriež parametru group_id katram kurjeram, kas jāizmanto, importējot klientus.

WhatsApp gadījumā tā atgriež arī lauku status, kuram var būt šādas vērtības:

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

Ceļš

api key* - piekļuves marķieris

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

Iegūt bloku sarakstu no bota plūsmas

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

URL pieprasījums: https://chatter.mavibot.ai/api/\<api_key>/get_messages

Piekļuves atļauja, ģenerējot atslēgu: "Atļauja modificēt vai dzēst klienta informāciju".

Ceļš

api key* - piekļuves marķieris

Iegūt ligzdotos klienta datus

Ja nepieciešamas papildu metodes, lūdzu, sazinieties ar atbalsta dienestu.