נקודות קצה של API בפלטפורמת Chat

נקודות הקצה (endpoints) של ה-API של פלטפורמת הצ'אט מספקות גישה לאובייקטים של הצ'אט. אובייקט צ'אט נוצר לכל צ'אט שמתבצע אל Contact Center AI Platform (פלטפורמת CCAI) וממנה.

אלה נקודות הקצה של ה-API של פלטפורמת הצ'אט:

• עדכון של צ'אט

• שליחת הודעות בצ'אט

• העברה של צ'אט עם סוכן וירטואלי לטיפול ברמה גבוהה יותר

• עדכון ההסלמה

• הוספת תמונה שהועלתה לצ'אט

• איך שולפים את כל התמונות מהצ'אט

• קבלת כתובת URL להעלאת תמונה עם חתימה מראש

• הוספת סרטון שהועלה לצ'אט

• איך מאחזרים את כל הסרטונים מהצ'אט

• קבלת כתובת URL להעלאת סרטון עם חתימה מראש

• יצירת צ'אט

• החזרת מזהה צ'אט

• המשך ההתכתבות בצ'אט

• קבלת מאפייני נתונים שמורים במהלך צ'אט

• עדכון מאפייני נתונים שמורים במהלך צ'אט

• שליחת נתונים בהתאמה אישית בצ'אט

• עדכון משתמש קצה במהלך שיחת צ'אט פעילה

אובייקט צ'אט

אובייקט צ'אט נוצר לכל סשן צ'אט בנייד ובאינטרנט בפלטפורמת CCAI. זהו אובייקט הצ'אט:

{
    "id": "integer",
    "status": "string",
    "status_text": "string",
    "features": [
        "string",
        "string"
    ],
    "created_at": "string",
    "ends_at": "string",
    "timeout_at": "string",
    "agent": {
        "id": "integer",
        "name": "string",
        "first_name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "virtual_agent": {
        "id": "integer",
        "name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "all_agents": [
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string",
            "status": "string"
        },
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string",
            "status": "string"
        }
    ],
    "all_virtual_agents": [
        {
            "id": "integer",
            "name": "string",
            "avatar_url": "string",
            "status": "string"
        },
        {
            "id": "integer",
            "name": "string",
            "avatar_url": "string",
            "status": "string"
        }
    ],
    "lang": "string",
    "menus": [
        {
            "id": "integer",
            "name": "string"
        },
        {
            "id": "integer",
            "name": "string"
        }
    ],
    "end_user": {
        "id": "integer",
        "identifier": "string"
    }
}

עדכון שיחה

פרמטר	חובה	סוג הנתונים	הגדרה
id	TRUE	מספר שלם	מזהה הצ'אט לעדכון

נקודת קצה (endpoint):

Method: PATCH
Type: RAW
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:id

כותרות:

מפתח	ערך	תיאור
סוג התוכן	application/json
אישור	application/json

Body:

{
    "finished_by_user_id": "integer",
    "chat": {
        "deflection_channel": "string",
        "status": "string",
        "escalation_id": "integer"
    }
}

דוגמה לבקשה ולתשובות

בקטעים הבאים מופיעות דוגמאות לבקשות לנקודת הקצה.

עדכון שיחה

בדוגמה הזו מוצג עדכון מוצלח של צ'אט קיים

בקשה

כותרות:

מפתח	ערך	תיאור
סוג התוכן	application/json
אישור	application/json

שאילתה:

מפתח	ערך	תיאור
id	מספר שלם	(חובה)

Body:

{
    "finished_by_user_id": "integer",
    "chat": {
        "deflection_channel": "string",
        "status": "finished",
        "escalation_id": "integer"
    }
}

תשובה

{
    "id": "integer",
    "status": "string",
    "status_text": "string",
    "features": [
        "string",
        "string"
    ],
    "created_at": "string",
    "ends_at": "string",
    "timeout_at": "string",
    "agent": {
        "id": "integer",
        "name": "string",
        "first_name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "virtual_agent": {
        "id": "integer",
        "name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "all_agents": [
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string",
            "status": "string"
        },
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string",
            "status": "string"
        }
    ],
    "all_virtual_agents": [
        {
            "id": "integer",
            "name": "string",
            "avatar_url": "string",
            "status": "string"
        },
        {
            "id": "integer",
            "name": "string",
            "avatar_url": "string",
            "status": "string"
        }
    ],
    "lang": "string",
    "menus": [
        {
            "id": "integer",
            "name": "string"
        },
        {
            "id": "integer",
            "name": "string"
        }
    ],
    "end_user": {
        "id": "integer",
        "identifier": "string"
    }
}

קוד הסטטוס: 200

שליחת הודעה בצ'אט

השיטה הזו מאפשרת לשלוח הודעה בסשן צ'אט קיים.

פרמטר	חובה	סוג הנתונים	הגדרה
id	TRUE	מספר שלם	מזהה הצ'אט שאליו ההודעה צריכה להישלח.

נקודת קצה (endpoint):

Method: POST
Type: RAW
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:id/message

כותרות:

מפתח	ערך	תיאור
סוג התוכן	application/json

Body:

{
    "from_user_id": integer,
    "message": {
            "type": "string",
            "content": "string"
    }
}

דוגמה לבקשה ולתשובות

בקטעים הבאים מופיעות דוגמאות לבקשות לנקודת הקצה.

ההודעה נשלחה בהצלחה

בדוגמה הזו מוצג תהליך שליחה מוצלח של הודעה לסשן צ'אט קיים.

בקשה

כותרות:

מפתח	ערך	תיאור
סוג התוכן	application/json
אישור	application/json

שאילתה:

מפתח	ערך	תיאור
id	מספר שלם	(חובה)

Body:

{
    "from_user_id": integer,
    "message": {
            "type": "string",
            "content": "string"
    }
}

תשובה

{
}

קוד הסטטוס: 200

העברת שיחה עם נציג וירטואלי לטיפול של נציג תמיכה

העברת צ'אט מסוכן וירטואלי לנציג תמיכה אנושי.

פרמטר	חובה	סוג הנתונים	הגדרה
chat_id	TRUE	מספר שלם	מזהה הצ'אט שנדרש להעברה לטיפול ברמה גבוהה יותר.

נקודת קצה (endpoint):

Method: POST
Type: RAW
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:chat_id/escalations

כותרות:

מפתח	ערך	תיאור
סוג התוכן	application/json
אישור	application/json

Body:

{
    "reason": "string",
    "force_escalate": "boolean"
}

דוגמה לבקשה ולתשובות

בקטעים הבאים מופיעות דוגמאות לבקשות לנקודת הקצה.

העברת הצ'אט לטיפול ברמה גבוהה יותר בוצעה בהצלחה

בדוגמה הזו מוצגת בקשה להעברת צ'אט קיים לנציג שירות אנושי.

בקשה

כותרות:

מפתח	ערך	תיאור
סוג התוכן	application/json
אישור	application/json

שאילתה:

מפתח	ערך	תיאור
chat_id	מספר שלם	(חובה)

Body:

{
    "reason": "by_end_user_ask",
    "force_escalate": true
}

תשובה

{
    "id": "integer",
    "chat_id": "integer",
    "status": "string"
}

קוד הסטטוס: 200

עדכון העברת הטיפול

הוא משמש רק לבחירת ערוץ ההפניה.

פרמטר	חובה	סוג הנתונים	הגדרה
chat_id	TRUE	מספר שלם	מזהה הצ'אט שנדרש לעדכון מזהה תפריט ההפניה.
id	TRUE	מספר שלם	מזהה התפריט הנדרש.

נקודת קצה (endpoint):

Method: PATCH
Type: RAW
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:chat_id/escalations/:id

כותרות:

מפתח	ערך	תיאור
סוג התוכן	application/json

Body:

{
    "deflection_channel": "string"
}

דוגמה לבקשה ולתשובות

בקטעים הבאים מופיעות דוגמאות לבקשות לנקודת הקצה.

העדכון של העברת הטיפול לדרג גבוה יותר בוצע בהצלחה

בדוגמה הזו מוצג עדכון מוצלח של ערוץ ההסלמה.

בקשה

כותרות:

מפתח	ערך	תיאור
סוג התוכן	application/json
אישור	application/json

שאילתה:

מפתח	ערך	תיאור
chat_id	מספר שלם	(חובה)
id	מספר שלם	(חובה)

Body:

{
    "deflection_channel": "string"
}

תשובה

{
    "id": "integer",
    "chat_id": "integer",
    "status": "string"
}

קוד הסטטוס: 200

הוספת תמונה שהועלתה לשיחה

הוספת תמונה שהועלתה לאחסון המדיה לשיחה

פרמטר	חובה	סוג הנתונים	הגדרה
chat_id	TRUE	מספר שלם	מזהה הצ'אט שנדרש כדי להוסיף את התמונה.

נקודת קצה (endpoint):

Method: POST
Type: RAW
URL: https://{subdomain}.​{domain}/apps/api/v1/chats/:chat_id/photos

כותרות:

מפתח	ערך	תיאור
סוג התוכן	application/json
אישור	application/json

Body:

{
    "photo": [
        {
            "s3_path": "string",
            "photo_type": "string"
        },
        {
            "s3_path": "string",
            "photo_type": "string"
        }
    ]
}

דוגמה לבקשה ולתשובות

בקטעים הבאים מופיעות דוגמאות לבקשות לנקודת הקצה.

התמונה נוספה לצ'אט בהצלחה

בדוגמה הבאה מוצגת הוספה של תמונה שהועלתה לאחסון מדיה לשיחה קיימת ב-Chat.

בקשה

כותרות:

מפתח	ערך	תיאור
סוג התוכן	application/json
אישור	application/json

שאילתה:

מפתח	ערך	תיאור
chat_id	מספר שלם	(חובה)

Body:

{
    "photo": [
        {
            "s3_path": "string",
            "photo_type": "string"
        },
        {
            "s3_path": "string",
            "photo_type": "string"
        }
    ]
}

תשובה

{
    "url": "string",
    "media_id": "integer"
}

קוד הסטטוס: 200

שליפת כל התמונות מהצ'אט

אחזור מזהה המדיה וכתובת ה-URL של האחסון של כל התמונות שמצורפות לצ'אט.

פרמטר	חובה	סוג הנתונים	הגדרה
chat_id	TRUE	מספר שלם	מזהה הצ'אט הנדרש כדי לקבל את פרטי המדיה.

נקודת קצה (endpoint):

Method: GET
Type:
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:chat_id/photos

כותרות:

מפתח	ערך	תיאור
אישור	application/json

דוגמה לבקשה ולתשובות

בקטעים הבאים מופיעות דוגמאות לבקשות לנקודת הקצה.

המידע על התמונה בצ'אט אוחזר בהצלחה

בדוגמה הזו מוצגת קריאה מוצלחת ל-API כדי לקבל את פרטי התמונה בסשן צ'אט קיים.

בקשה

כותרות:

מפתח	ערך	תיאור
אישור	application/json

שאילתה:

מפתח	ערך	תיאור
chat_id	מספר שלם	(חובה)

תשובה

[
    {
        "url": "string",
        "media_id": "integer"
    },
    {
        "url": "string",
        "media_id": "integer"
    }
]

קוד הסטטוס: 200

קבלת כתובת URL להעלאת תמונה עם חתימה מראש

משמשת לקבלת כתובת URL להעלאה בחתימה מראש של תמונות.

פרמטר	חובה	סוג הנתונים	הגדרה
chat_id	TRUE	מספר שלם	מזהה הצ'אט הנדרש שישויך לכתובת ה-URL של התמונה עם החתימה מראש.

נקודת קצה (endpoint):

Method: POST
Type: RAW
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:chat_id/photos/upload

כותרות:

מפתח	ערך	תיאור
סוג התוכן	application/json
אישור	application/json

דוגמה לבקשה ולתשובות

בקטעים הבאים מופיעות דוגמאות לבקשות לנקודת הקצה.

השליפה של כתובת ה-URL החתומה להעלאה הושלמה

זו דוגמה לבקשה מוצלחת עם אחזור של כתובת URL חתומה להעלאת תמונה.

בקשה

כותרות:

מפתח	ערך	תיאור
אישור	application/json

שאילתה:

מפתח	ערך	תיאור
chat_id	מספר שלם	(חובה)

תשובה

{
    "url": "string",
    "fields": {
        "key": "string",
        "success_action_status": "string",
        "Content-Type": "string",
        "Cache-Control": "string",
        "acl": "string",
        "policy": "string",
        "x-amz-credential": "string",
        "x-amz-algorithm": "string",
        "x-amz-date": "string",
        "x-amz-security-token": "string",
        "x-amz-signature": "string",
        "x-goog-algorithm": "string",
        "x-goog-credential": "string",
        "x-goog-date": "string",
        "x-goog-signature": "string"
    }
}

קוד הסטטוס: 200

הוספת סרטון שהועלה לשיחה

להוסיף לשיחה סרטון שהועלה לאחסון המדיה.

פרמטר	חובה	סוג הנתונים	הגדרה
chat_id	TRUE	מספר שלם	מזהה הצ'אט הנדרש שאליו הסרטון צריך להיות משויך.

נקודת קצה (endpoint):

Method: POST
Type: RAW
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:chat_id/videos

כותרות:

מפתח	ערך	תיאור
סוג התוכן	application/json
אישור	application/json

Body:

{
    "video": {
        "s3_path": "string",
        "gcs_path": "string"
    }
}

דוגמה לבקשה ולתשובות

בקטעים הבאים מופיעות דוגמאות לבקשות לנקודת הקצה.

העלאה מוצלחת של סרטון לשיחה בצ'אט

בדוגמה הזו אפשר לראות העלאה מוצלחת של סרטון לסשן צ'אט.

בקשה

כותרות:

מפתח	ערך	תיאור
אישור	application/json

שאילתה:

מפתח	ערך	תיאור
chat_id	מספר שלם	(חובה)

Body:

{
    "photo": [
        {
            "s3_path": "string",
            "photo_type": "string"
        },
        {
            "s3_path": "string",
            "photo_type": "string"
        }
    ]
}

תשובה

Body
{
    "url": "string",
    "media_id": "integer"
}

קוד הסטטוס: 200

אחזור כל הסרטונים מהצ'אט

מקבלים את מזהה המדיה ואת כתובת ה-URL של האחסון של כל הסרטונים שמצורפים לצ'אט.

פרמטר	חובה	סוג הנתונים	הגדרה
chat_id	TRUE	מספר שלם	מזהה הצ'אט הנדרש שכתובות ה-URL של הסרטונים יאוחזרו ממנו.

נקודת קצה (endpoint):

Method: GET
Type:
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:chat_id/videos

כותרות:

מפתח	ערך	תיאור
סוג התוכן	application/json
אישור	application/json

דוגמה לבקשה ולתשובות

בקטעים הבאים מופיעות דוגמאות לבקשות לנקודת הקצה.

איך מאחזרים את כל כתובות ה-URL של סרטונים בשיחה

בדוגמה הזו מוסבר איך לאחזר את כל כתובות ה-URL של סרטונים בצ'אט קיים.

בקשה

כותרות:

מפתח	ערך	תיאור
אישור	application/json

שאילתה:

מפתח	ערך	תיאור
chat_id	מספר שלם	(חובה)

תשובה

[
    {
        "url": "string",
        "media_id": "integer"
    },
    {
        "url": "string",
        "media_id": "integer"
    }
]

קוד הסטטוס: 200

קבלת כתובת URL להעלאת סרטון עם חתימה מראש

משמש לקבלת כתובת URL להעלאה שחתום מראש לסרטונים.

פרמטר	חובה	סוג הנתונים	הגדרה
chat_id	TRUE	מספר שלם	מזהה הצ'אט הנדרש שישויך לכתובת ה-URL של הסרטון עם החתימה מראש.

נקודת קצה (endpoint):

Method: POST
Type: RAW
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:chat_id/videos/upload

כותרות:

מפתח	ערך	תיאור
סוג התוכן	application/json
אישור	application/json

דוגמה לבקשה ולתשובות

בקטעים הבאים מופיעות דוגמאות לבקשות לנקודת הקצה.

השליפה של כתובת URL חתומה להעלאת סרטון הושלמה בהצלחה

בדוגמה הבאה מוצגת בקשה תקינה שכוללת אחזור של כתובת URL חתומה להעלאת סרטון.

בקשה

כותרות:

מפתח	ערך	תיאור
אישור	application/json

שאילתה:

מפתח	ערך	תיאור
chat_id	מספר שלם	(חובה)

תשובה

{
    "url": "string",
    "fields": {
        "key": "string",
        "success_action_status": "string",
        "Content-Type": "string",
        "Cache-Control": "string",
        "acl": "string",
        "policy": "string",
        "x-amz-credential": "string",
        "x-amz-algorithm": "string",
        "x-amz-date": "string",
        "x-amz-security-token": "string",
        "x-amz-signature": "string",
        "x-goog-algorithm": "string",
        "x-goog-credential": "string",
        "x-goog-date": "string",
        "x-goog-signature": "string"
    }
}

קוד הסטטוס: 200

יצירת צ'אט

מתחילים סשן צ'אט חדש.

דוגמה לבקשה

שיטה: POST

כתובת URL: https://{subdomain}.{domain}/apps/api/v1/chats

כותרות

מפתח	ערך	תיאור
סוג התוכן	application/json
אישור	application/json

גוף

{
    "chat": {
        "menu_id": "integer",
        "end_user_id": "integer",
        "lang": "string",
        "email": "string",
        "context": "object",
        "transcript": "object"
    },
    "end_user": {
        "phone": "string"
    }
}

Context:

אובייקט context כולל את אובייקט value, שמעביר מטא-נתונים לשיחה בצ'אט. אפשר להעביר את אובייקט context לסוכנים וירטואליים כפרמטר נתונים לא חתום. מקרה לדוגמה:

{
    "context": {
        {"value":
            {"foo": "bar",
             "key": "value"}
        }
    }
}

בדוגמה הזו, הערך של פרמטר הנתונים הלא חתומים בשדה הנכנס הוא context, ואפשר להגדיר את שדה היעד כ-context. כך תוכלו להשתמש ב-$session.params.context.foo או ב-$session.params.context.key.

דוגמה לתשובה

{
    "id": "integer",
    "status": "string",
    "status_text": "string",
    "features": [
        "string",
        "string"
    ],
    "created_at": "string",
    "ends_at": "string",
    "timeout_at": "string",
    "agent": {
        "id": "integer",
        "name": "string",
        "first_name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "virtual_agent": {
        "id": "integer",
        "name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "all_agents": [
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string",
            "status": "string"
        },
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string",
            "status": "string"
        }
    ],
    "all_virtual_agents": [
        {
            "id": "integer",
            "name": "string",
            "avatar_url": "string",
            "status": "string"
        },
        {
            "id": "integer",
            "name": "string",
            "avatar_url": "string",
            "status": "string"
        }
    ],
    "lang": "string",
    "menus": [
        {
            "id": "integer",
            "name": "string"
        },
        {
            "id": "integer",
            "name": "string"
        }
    ],
    "end_user": {
        "id": "integer",
        "identifier": "string"
    }
}

החזרת צ'אט לפי מזהה

השיטה הזו מחזירה את אובייקט הצ'אט של מזהה צ'אט נתון.

נקודת קצה (endpoint):

Method: GET
Type:
URL: https://{subdomain}.​{domain}/apps/api/v1/chats/:id

כותרות:

מפתח	ערך	תיאור
סוג התוכן	application/json
אישור	application/json

שאילתה:

מפתח	ערך	תיאור
chat_id	מספר שלם	(חובה)

דוגמה לבקשה ולתשובות

בקטעים הבאים מופיעות דוגמאות לבקשות לנקודת הקצה.

שחזור צ'אט בהצלחה

בדוגמה הבאה מוצגת בקשה מוצלחת למזהה צ'אט קיים.

בקשה

כותרות:

מפתח	ערך	תיאור
סוג התוכן	application/json
אישור	application/json

שאילתה:

מפתח	ערך	תיאור
chat_id	מספר שלם	(חובה)

תשובה

{
    "id": "integer",
    "status": "string",
    "status_text": "string",
    "features": [
        "string",
        "string"
    ],
    "created_at": "string",
    "ends_at": "string",
    "timeout_at": "string",
    "agent": {
        "id": "integer",
        "name": "string",
        "first_name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "virtual_agent": {
        "id": "integer",
        "name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "all_agents": [
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string",
            "status": "string"
        },
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string",
            "status": "string"
        }
    ],
    "all_virtual_agents": [
        {
            "id": "integer",
            "name": "string",
            "avatar_url": "string",
            "status": "string"
        },
        {
            "id": "integer",
            "name": "string",
            "avatar_url": "string",
            "status": "string"
        }
    ],
    "lang": "string",
    "menus": [
        {
            "id": "integer",
            "name": "string"
        },
        {
            "id": "integer",
            "name": "string"
        }
    ],
    "end_user": {
        "id": "integer",
        "identifier": "string"
    }
}

קוד הסטטוס: 200

המשך הצ'אט

המשך שיחה שנסגרה בגלל חוסר פעילות. הסטטוס של הצ'אט חייב להיות dismissed או va_dismissed.

דוגמה לבקשה

שיטה: POST

כתובת URL: https://{subdomain}.{domain}/apps/api/v1/chats/:id/resume

כותרות

מפתח	ערך	תיאור
אישור	application/json

משתני כתובת URL

מפתח	ערך	תיאור
id	מספר שלם	(חובה)

דוגמה לתשובה

{
    "id": "integer",
    "status": "string",
    "status_text": "string",
    "features": [
        "string",
        "string"
    ],
    "created_at": "string",
    "ends_at": "string",
    "timeout_at": "string",
    "agent": {
        "id": "integer",
        "name": "string",
        "first_name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "virtual_agent": {
        "id": "integer",
        "name": "string",
        "va_alias": "string",
        "avatar_url": "string"
    },
    "all_agents": [
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string"
        }
    ],
    "all_virtual_agents": [
        {
            "id": "integer",
            "name": "string",
            "va_alias": "string",
            "avatar_url": "string"
        }
    ],
    "lang": "string",
    "menus": [
        {
            "id": "integer",
            "name": "string"
        }
    ],
    "end_user": {
        "id": "integer",
        "identifier": "string"
    }
}

קבלת מאפייני נתונים שמורים במהלך צ'אט

נקודת קצה (endpoint)

Method: GET
Type: RAW
URL: https://{subdomain}.{domain}/apps/api/v1/chats/:id/customer_flag

דוגמה לבקשה ולתשובות

בקטע הזה מופיעות דוגמה לבקשה ולתגובה של נקודת הקצה.

הפעולה הצליחה

בדוגמה הזו מוצגת קריאה מוצלחת.

בקשה

כותרות

מפתח	ערך	תיאור
אישור	application/json

משתני כתובת URL

מפתח	ערך	תיאור
id	מספר שלם	(חובה)

תשובה

{
    "verified_customer": "boolean",
    "bad_actor": "boolean",
    "repeat_customer": "boolean"
}

עדכון מאפייני נתונים שמורים במהלך שיחה

נקודת קצה (endpoint)

Method: POST
Type: RAW
URL: https://{subdomain}.{domain}/apps/api/v1/chats/:id/customer_flag

משתני כתובת URL

מפתח	ערך	תיאור
id	מספר שלם	(חובה)

Body

{
    "verified_customer": "boolean",
    "bad_actor": "boolean",
    "repeat_customers": "boolean"
}

שליחת נתונים בהתאמה אישית בצ'אט

שליחת נתונים בהתאמה אישית בצ'אט.

דוגמה לבקשה

שיטה: POST

כתובת URL: https://{subdomain}.{domain}/apps/api/v1/chats/:id/custom_data

כותרות

מפתח	ערך	תיאור
סוג התוכן	application/json

משתני כתובת URL

מפתח	ערך	תיאור
id	מספר שלם	(חובה)

דוגמה לתשובה

// Use unsecured parameter
{
"signed": false,
"data": {
// Start customer_flag fields
"reserved_verified_customer": {
"label": "LABEL 1",
"value": true
},
"reserved_bad_actor": {
"label": "LABEL 2",
"value": false
},
"reserved_repeat_customer": {
"label": "LABEL 3",
"value": true
},
// End customer_flag fields
"field1": {
"label": "LABEL 4",
"value": "dummy1"
},
"field2": {
"label": "LABEL 5",
"value": "dummy2"
}
}
}
// Use secured parameter
// {
// "signed": true,
// "signed_data": "eyJhbGciOiJIUzI1NiJ9.eyJjdXN0b21fZGF0YSI6eyJyZXNlcnZlZF92ZXJpZmllZF9jdXN0b21lciI6eyJ2YWx1ZSI6ZmFsc2V9LCJyZXNlcnZlZF9iYWRfYWN0b3IiOnsidmFsdWUiOnRydWV9LCJyZXNlcnZlZF9yZXBlYXRfY3VzdG9tZXIiOnsidmFsdWUiOmZhbHNlfSwiZmllbGQxIjp7InZhbHVlIjoiZHVtbXkxMTEifSwiZmllbGQyIjp7InZhbHVlIjoiZHVtbXkyMjIifX0sImV4cCI6MTcyOTY4MzU5MywiaWF0IjoxNzI5Njc5OTkzfQ.BMskgKTM3DbgrMLWjI46ZJ1K73H25JRd16SgHK0A1Ts"
// }
// ======================= How to create <signed_data> =======================
// payload = {
// "custom_data": {
// // Start customer_flag fields
// "reserved_verified_customer": {
// "label": "LABEL 1",
// "value": true
// },
// "reserved_bad_actor": {
// "label": "LABEL 2",
// "value": false
// },
// "reserved_repeat_customer": {
// "label": "LABEL 3",
// "value": true
// },
// // End customer_flag fields
// "field1": {
// "label": "LABEL 4",
// "value": "dummy1"
// },
// "field2": {
// "label": "LABEL 5",
// "value": "dummy2"
// }
// },
// "exp": 1734567890, // expiration timestamp
// "iat": 1734560000 // issue timestamp
// }
// signed_data = JWT.encode(payload, 'Company secret', 'HS256')
// ======================= End how to create <signed_data> =======================

עדכון משתמש קצה במהלך שיחת צ'אט פעילה

עדכון משתמש הקצה שמשויך לסשן הצ'אט הפעיל הנוכחי. בנוסף, הוא גם מעדכן את הפרטים ליצירת קשר שמקושרים לכרטיס ב-CRM. חובה לציין את _Identifier, ואילו name, email ו-phone הם אופציונליים.

הערה: אם כבר הוגדר מספר טלפון, ציון פרמטר של טלפון לא יעדכן את מספר הטלפון.

דוגמה לבקשה

שיטה: POST

כתובת URL: https://{subdomain}.{domain}/apps/api/v1/chats/:chat_id/end-user

כותרות

מפתח	ערך	תיאור
סוג התוכן	application/json

משתני כתובת URL

מפתח	ערך	תיאור
chat_id	מספר שלם

גוף

{
    "identifier": "string",
    "name": "string",
    "email": "string",
    "phone": "string"
}

דוגמה לתשובה

{
    "message": "accepted"
}