API של אנשי קשר ב-PHP

פונקציית ממשק API מספקת שיטות שירות רבות שבהן תוכל להשתמש כדי ליצור אינטראקציה עם פעולות הקשורות לאנשי קשר מקטע ה-PHP המותאם אישית שלך או תוסף מותאם אישית.

#אתחול #

$contactApi = FluentCrmApi('contacts');

1

FluentCrmApi('contacts') מחזיר בעצם FluentCrm\App\Api\Classes\Contacts מחלקה שיש לה שיטות שונות לאינטראקציה עם מנוי דגם.

#שיטות #

#getContact($emailOrContactId) #

/*
* מצא איש קשר בדוא"ל או מזהה מנוי
* אתה יכול למצוא איש קשר באימייל או מזהה מנוי (SubscriberId אינו מזהה המשתמש).
* @return: null או FluentCrm\App\Models\Subscriber Model
*/
$contact = $contactApi->getContact($emailOrContactId);

1
2
3
4
5
6

#getContactByUserRef($userId) #

/*
* מצא איש קשר לפי user_id
* אתה יכול למצוא איש קשר לפי user_id
* @return: null או FluentCrm\App\Models\Subscriber Model
*/
$contact = $contactApi-> getContactByUserRef($userId);

1
2
3
4
5
6

#getCurrentContact() #

/*
* קבל את פרופיל הקשר של המשתמש המחובר עדכני
* @param: $cached boolean, אם זה נכון אז זה ישתמש במטמון בזמן ריצה
* @param: $useSecureCookie בוליאני, אם נכון, הוא יבדוק את ערך ה-cookie מקישור האימייל עבור משתמשים מנותקים.
* @return: null או FluentCrm\App\Models\Subscriber Model
*/
$contact = $contactApi->getCurrentContact($cached = true, $useSecureCookie = false);

1
2
3
4
5
6
7

#getContactBySecureHash($hash) #

אם יש לך איש קשר מאובטח בקובץ ה-cookie, תוכל לקבל את ה-hash המנוי

/*
* קבל מנוי באמצעות hash מאובטח
* @param: מחרוזת 
* @return: null או FluentCrm\App\Models\Subscriber Model
*/
$contact = $contactApi->getContactBySecureHash($hash);

1
2
3
4
5
6

#createOrUpdate() #

צור או עדכן את הנתונים של איש הקשר, כולל תגים / רשימות / שדות מותאמים אישית

פרמטרים

>
• מערך נתונים $ של נתוני אנשי הקשר
• $forceUpdate בוליאני, אם נכון אז הסטטוס של איש הקשר יתעדכן ללא קשר לסטטוס הישן שלו
• $deleteOtherValues ​​בוליאני, אם נכון, נתוני שדות אנשי קשר מותאמים אישית יישמרו וזה יסיר ערכים אחרים
• $sync בוליאני, אין עדיין מקרה שימוש אבל הוא כאן למקרי שימוש עתידיים.

מחזירות false | FluentCrm\App\Models\Subscriber Model

$contactApi = FluentCrmApi('contacts');

/*
* עדכן/הוסף איש קשר
* ניתן ליצור או לעדכן איש קשר בשיחה אחת
*/

$data = [
    'first_name' => 'ג'ון',
    'last_name' => 'צְבִיָה',
    'email' => '[email protected]', // נדרש
    'סטטוס' => 'תָלוּי וְעוֹמֵד',
    'תגים' => [1,2,3, 'תג דינמי'], // תג ids/slugs/title כמערך
    'רשימות' => [4, 'רשימה דינמית'] // רשום ids/slugs/title כמערך,
    'detach_tags' => [6, 'another_tag'] // תג ids/slugs/title כמערך,
    'detach_lists' => [10, 'list_slug'] // רשום ids/slugs/title כמערך,
    'custom_values' => [
        'custom_field_slug_1' => 'ערך_שדה_מותאם_1',
        'custom_field_slug_2' => 'ערך_שדה_מותאם_2',
    ]
];

$contact = $contactApi->createOrUpdate($data);

// שלח הודעת אימייל להצטרפות כפולה אם הסטטוס בהמתנה
if($contact && $contact->status == 'בהמתנה') {
    $contact->sendDoubleOptinEmail();
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

עבור פרמטר תגים ורשימות אתה יכול להשתמש במזהי תגים, שבלולים של תגים או כותרות תגים או מעורבות. כנ”ל לגבי רשימות.

אם תספק ערך מחרוזת עבור תגים או רשימות, הוא ינסה למצוא את התג או הרשימה לפי כותרת ואם לא נמצא, הוא יצור תג או רשימה חדשים.

שדות ראשיים זמינים הניתנים למילוי

< tr>< td>last_name< /tr>

תכונה	סוג נתונים	תגובה
user_id	מספר שלם	מזהה משתמש ב-WordPress
company_id	מספר שלם	מזהה חברה ראשי
תחילית	מחרוזת	קידומת שם
first_name	מחרוזת	שם פרטי
מחרוזת	שם משפחה
email	מחרוזת	כתובת הדוא”ל של איש הקשר
אזור זמן	מחרוזת	מחרוזת טווח זמן (פורמט ISO)
address_line_1	מחרוזת	—
address_line_2	מחרוזת	—
מיקוד	מחרוזת	—
עיר	מחרוזת	—
מצב	מחרוזת	—< /td>
מדינה	מחרוזת	—
ip	מחרוזת	—
קו רוחב	עשרוני	—
קו אורך	עשרוני	—
טלפון	מחרוזת	—
status	מחרוזת	ערכים אפשריים: בהמתנה / נרשם / חזר / לא נרשם< /td>
contact_type	מחרוזת	lead/customer
source	מחרוזת	—
avatar	מחרוזת / כתובת URL	כתובת אתר תמונה מותאמת אישית של איש קשר
תאריך_לידה	תאריך	פורמט י-מ-ד
פעילות אחרונה	תאריך שעה	—
updated_at	תאריך שעה	—

#getInstance() #

אם אתה רוצה לגשת למודל הגולמי FluentCrm\App\Models\Subscriber  אז אתה משתמש כך

$subscriberInstance = FluentCrmApi('contacts')->getInstance();

1

#סינון אנשי קשר #

$contactApi = FluentCrmApi('contacts');

// קבל אנשי קשר מנויים
$subscribedContacts = $contactApi->getInstance()
    ->where('status', 'subscribed')
    ->get(); // אתה יכול גם להשתמש ב-paginate() במקום get();

// קבל אנשי קשר ממתינים ורשומים כאחד
$contacts = $contactApi->getInstance()
    ->whereIn('status', ['unsubscribed', 'pending'])
    ->get();

// קבל אנשי קשר לפי מזהי תג
$tagIds = [1,2];
$tagOneTwoContacts = $contactApi->getInstance()
    ->filterByTags($tagIds)
    ->get();

// קבל אנשי קשר לפי מזהי רשימה
$listIds = [1,2];
$ListOneTwoContacts = $contactApi->getInstance()
    ->filterByLists($listIds)
    ->get();

// חפש אנשי קשר
$searchResult = $contactApi->getInstance()
    ->searchBy('search_string')
    ->get();

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

#שיטות ספציפיות ליצירת קשר #

כדי ליצור אינטראקציה עם איש קשר יחיד, תוכל להשתמש בשיטות הבאות

אתחול

$contactApi = FluentCrmApi('contacts');
$subscriber = $contactApi->getContact($emailOrContactId);

1
2

#attachLists($listIds) #

צרף רשימות למנוי

>
• פרמטרים
  >
  • מערך $listIds או רשימה מזהים / כותרת / שבלולים
• מחזיר את FluentCrm\App\Models\Subscriber

#שימוש #

$subscriber->attachLists([1,2,3, 'list_slug']);

1

#detachLists($listIds) #

הסר רשימות ממנוי

>
• פרמטרים
  >
  • מערך $listIds של מזהי רשימה / כותרת / שבלולים
• מחזיר את FluentCrm\App\Models\Subscriber

#שימוש #

$subscriber->detachLists([1,2,3, 'list_slug_or_title']);

1

#attachTags($tagIds) #

צרף תגים למנוי

>
• פרמטרים
  >
  • מערך $tagIds של מזהי תגים / כותרת / שבלולים
• מחזיר את FluentCrm\App\Models\Subscriber

#שימוש #

$subscriber->attachTags([1,2,3, 'title_or_slug']);

1

#detachTags($tagIds) #

הסר תגים ממנוי

>
• פרמטרים
  >
  • מערך $tagIds או מזהי תג / title / slugs
• מחזיר את FluentCrm\App\Models\Subscriber

#שימוש #

$subscriber->detachTags([1,2,3, 'title_or_slug']);

1

#custom_fields() #

קבל נתוני שדות מותאמים אישית של איש קשר

>
• פרמטרים
  >
  • אף אחד
• מחזיר מערך

#שימוש #

$customData = $subscriber->custom_fields();

1

#סטטיסטיקות #

קבל את הודעות הדוא”ל שנשלחו מאנשי הקשר, הפתיחות וספירת הקליקים

>
• פרמטרים
  >
  • אף אחד
• מחזיר מערך

#שימוש #

$contactStats = $subscriber->stats();

1

#sendDoubleOptinEmail() #

שלח דוא”ל Double Optin אם איש הקשר נמצא במצב ממתין

>
• פרמטרים
  >
  • אף אחד
• מחזירה בוליאנית

#שימוש #

$subscriber->sendDoubleOptinEmail();

1

#unsubscribeReason() #

קבל את סיבת ביטול הרישום אם איש קשר בטל את המנוי וספק משוב

>
• פרמטרים
  >
  • אף אחד
• מחזירה מחרוזת

#שימוש #

$reason = $subscriber->unsubscribeReason();

1

#unsubscribeReasonDate() #

קבל את תאריך סיבת ביטול המנוי אם איש הקשר בוטל

>
• פרמטרים
  >
  • אף אחד
• מחזירה תאריך מחרוזת או ריקה

#שימוש #

$sunsubscribeDate = $subscriber->unsubscribeReasonDate();

1

#hasAnyTagId() #

בדוק אם איש קשר הוא אחד מהתג שסופק

>
• פרמטרים
  >
  • מערך $tagIds של מזהי תגים או שבלולים או כותרות תגים
• מחזירה בוליאנית

#שימוש #

$isInTags = $subscriber->hasAnyTagId([1,2,3, 'title_or_slug']);

1

#hasAnyListId() #

בדוק אם איש קשר הוא אחד מהרשימה המסופקת

>
• פרמטרים
  >
  • מערך $listIds של מזהי רשימות או שבלולים או כותרות רשימות
• מחזירה בוליאנית

#שימוש #

$isInLists = $subscriber->hasAnyListId([1,2,3, 'title_or_slug']);

1

#getWpUser() #

קבל אובייקט WP User אם משתמש וורדפרס קיים באותו איש קשר

>
• פרמטרים
  >
  • אף אחד
• מחזיר את \WP_User או null

#שימוש #

$user = $subscriber->getWpUser();

1

#getWpUserId() #

קבל אובייקט WP User אם משתמש וורדפרס קיים באותו איש קשר

>
• פרמטרים
  >
  • אף אחד
• מחזירה INT או null

#שימוש #

$userId = $subscriber->getWpUserId();