Ugrás a fő tartalomra

SalesAutopilot API CRM metódusok

Áttekintés

CRM feladatok lekérdezése

Visszaadja a feltételnek megfelelő CRM feladatokat. Az alábbi módokon történhet a lekérdezés.

POST https://api.salesautopilot.com/listtask/<nl_id>

Paraméterek:

Paraméterek:

<nl_id>

A CRM lista azonosítója amelyből a feladatokat le szeretnénk kérdezni.

Hívás törzsében átadható paraméterek (JSON formátumban):

Hívás törzsében átadható paraméterek (JSON formátumban):

status

Feladat státusza, az 1-es érték a lezárt, a 0 érték pedig a nyitott feladatokat jelenti

start_date

Feladat kezdődátuma. A dátumot a következő formátumban kell átadni: YYYY.MM.DD HH:mm formában lehet megadni. Pl. 2017.12.05 11:00

end_date

Feladat vége dátum. A dátumot a start_date-nél megadott formátumban kell megadni.

Hívás törzse (példa):

	{"status" : "1",
	 "start_date" : "2017.12.05 11:00",
	 "end_date" : "2017.12.06 12:00"}
	

Válasz:

Tartalmazza a feladatoka adatait JSON formátumban. Sikeres hívás válasza:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
[
  {
    "event_id": "225450",
    "event_title": "Sa Teszt",
    "event_desc": "ez egy teszt",
    "event_start": "2017-01-20 17:08:00",
    "event_end": "2017-01-20 17:30:00",
    "event_status": "1",
    "event_location": "",
    "event_category": "",
    "created_by_username": "sandrine",
    "assigned_userid": "24632",
    "contact_email": "[email protected]",
    "customfields": {
      "Prioritás": "Magas"
    }
  },
  {
    "event_id": "231001",
    "event_title": "Teleefonhívás",
    "event_desc": "",
    "event_start": "2017-02-16 09:39:00",
    "event_end": "2017-02-16 00:00:00",
    "event_location": "",
    "event_category": "",
    "created_by_username": "sandrine",
    "assigned_userid": "24632",
    "contact_email": "[email protected]",
    "customfields": {
      "Prioritás": "Alacsony"
    }
  }
]

Adatok értelmezése:

Adatok értelmezése:

created_by_username

Annak a CRM felhasználónak a felhasználóneve, aki a feladatot létrehozta.

assigned_userid

Annak a CRM felahsználónak az azonosítója, akihez a feladat tartozik.

contact_email

Annak az ügyfélnek az email címe, akivel kapcsolatos a feladat.

customfields

A mennyiben a feladatokhoz definiált egyedi mezőket, azok név-érték párjai fognak itt megjelenni.

Feladat létrehozása

POST https://api.salesautopilot.com/addTask/<nl_id>/<id>

Paraméterek:

Paraméterek:

<nl_id>

A CRM lista azonosítója

<id>

A CRM listában lévő feliratkozó azonosítója, akihez a feladatot létre szeretnéd hozni.

Kötelezően átadandó értékek a hívás törzsében:

Kötelezően átadandó értékek a hívás törzsében:

uid

feladatot létrehozó SAPI user azonosítója

name

feladat elnevezése

start_date

feladat kezdődátuma

end_date

feladat befejező dátuma

category

feladat kategória azonosítója

crm_status

ha átadásra kerül az értéke, akkor a feliratkozó crm státusza erre kerül módosításra és a módosítás (miről-mire) is elmentésre kerül a logba

Opcionálisan átadandó értékek a hívás törzsében:

Opcionálisan átadandó értékek a hívás törzsében:

description

feladat részletesen leírása

status

feladat státusza (0 - függőben vagy 1 - elkészült) nem kötelező

assigned_user

feladathoz rendelt értékesítő / felelős SAPI user azonosítója

gcal_sync

1, ha szinkronzálódjon Google naptárral

gcal_uri

Google naptár URI-ja
(Az az e-mail cím, ami azonosítója a Google Naptárat. A Beállítások > Integrációk > Integráció beállítások fül alatt megtalálható, hogy pontosan melyik e-mail cím az.)

address

feladathoz rendelt cím (sima szövegként)

segments

mely szegmensek számára látszódjon (JSON tömbként a szegmens azonosítókat kell átadni)

Hívás törzse (példa):

{
"name" : "Teszt feladat",
"crm_status" : "Érdeklődő",
"category" : "88781",
"uid" : "41930",
"assigned_user" : "41930",
"start_date" : "2021-10-09 10:00",
"end_date" : "2021-10-15 10:00",
"gcal_sync" : "1",
"gcal_uri" : "[email protected]"
}

Válasz:

Sikeres feladat létrehozása esetén a válasz a feladat azonosítója lesz.

Feladat módosítása

A megadott feladatot módosítja a törzsben megadott új értékek alapján.

POST https://api.salesautopilot.com/modTask/<event_id>

Paraméterek:

Paraméterek:

<event_id>

A módosítandó CRM feladat azonosítója.

Ugyanazok a paraméterek módosíthatóak, mint amelyeket létrehozáskor is át lehet adni.

Feladat lezárása

Az adott feladat állapotát lezártra változtatja.

GET https://api.salesautopilot.com/closeevent/<event_id>

Paraméterek:

Paraméterek:

<event_id>

A feladat egyedi azonosítója.

Válasz:

Válasz sikeres hívás esetén:

200-as http code

Válasz hiba esetén:

200-astól eltérő http code

Választ kapott a kérdésére?