‫Google משתמשת בטכנולוגיית AI כדי לתרגם תוכן לשפה המועדפת עליך. בתרגומים כאלו עשויות להיות שגיאות.

נקודות קצה של סוכנים

Agent endpoints מספקות דרך לקבל אובייקטים של סוכנים. כל אובייקט של נציג מייצג נציג אחד ב-Contact Center AI Platform ‏(CCAI Platform). בדקו את המודל הבא כדי לראות אילו שדות עשויים להכיל פרטים אישיים מזהים (PII).

[
  {
    "id": 0,
    "email": "string",
    "created_at": "2018-05-30T20:46:31.333Z",
    "last_login_time": "2018-05-30T20:46:31.333Z",
    "first_name": "string",
    "middle_name": "string",
    "last_name": "string",
    "avatar_url": "string",
    "agent_number": "string",
    "status": {
      "id": 0,
      "name": "string",
      "color": "string"
    },
    "status_updated_at": "2018-05-30T20:46:31.333Z",
    "crm_authenticated": true,
    "online": true,
    "wrap_up": true,
    "call_count": 0,
    "chat_count": 0,
    "location": "string",
    "roles": [
      "agent"
    ],
    "teams": [
      {
        "id": 0,
        "name": "string",
        "parent_id": 0,
        "position": 0,
        "deleted": true,
        "agents_count": 0
      }
    ],
    "channels": [
      {
        "channel_type": "chat",
        "menu": {
          "id": 0,
          "name": "string",
          "parent_id": 0,
          "position": 0,
          "deleted": true,
          "hidden": "string",
          "menu_type": "ivr_menu",
          "output_msg": "string"
        }
      }
    ]
  }
]

סוכנים

נקודת הקצה /manager/api/v1/agents מחזירה אובייקטים של נציגים ונתוני סטטוס ונוכחות בזמן אמת של נציגים פעילים בלבד. נקודת הקצה הזו לא מחזירה רשומות של נציגים שהושבתו.

בטבלה הבאה מפורטים הפרמטרים של השאילתה שנתמכים על ידי נקודת הקצה /manager/api/v1/agents:

פרמטר	חובה	סוג הנתונים	הגדרה
ייפתח	לא נכון	String	משמש בשילוב עם per כדי לציין את מספר הדף של הרשומות. לדוגמה, אם הערך של per הוא 200 והערך של page הוא 2, התגובה תכיל את הרשומות 201-400, כי דף 1 יכיל את הרשומות 1-200.
לכל	לא נכון	String	משויך לדף כדי לציין כמה רשומות ייכללו בדף של רשומות. לדוגמה, אם הערך של per הוא 200 והערך של page הוא 2, התגובה תכיל את הרשומות 201-400, כי דף 1 יכיל את הרשומות 1-200.
id[]‎	לא נכון	Array[String]	‫Array[Strings]. מזהה הרשומות שרוצים לחפש ולהחזיר
agent_number[]	לא נכון	Array[String]	מספרי הסוכנים שהאדמין הקצה בזמן יצירת הסוכן
status_id[]	לא נכון	Array[String]	מסננים לפי סטטוס הסוכן
online[]	לא נכון	בוליאני	סינון לפי סטטוס החיבור של הסוכנים (אונליין או אופליין)
wrap_up[]	לא נכון	בוליאני	סינון לפי נציגים בסטטוס "סגירת קצוות"
location[]	לא נכון	Array[String]	מסננים לפי מיקום הסוכן
last_login_time[from]	לא נכון	השעה לפי שעון UTC	יוצר גבול תחתון של שדה זמן ההתחברות האחרון. כל הרשומות שיוחזרו יהיו אחרי הערך שהוזן.
last_login_time[to]	לא נכון	השעה לפי שעון UTC	יוצר גבול עליון של שדה זמן ההתחברות האחרון. כל הרשומות שיוחזרו יהיו לפני הערך שהוזן.
status_updated_at[from]	לא נכון	השעה לפי שעון UTC	יוצרת גבול תחתון של השדה "הסטטוס עודכן בתאריך". כל הרשומות שיוחזרו יהיו אחרי הערך שהוזן.
status_updated_at[to]	לא נכון	השעה לפי שעון UTC	יוצר גבול עליון של השדה "הסטטוס עודכן בתאריך". כל הרשומות שיוחזרו יהיו לפני הערך שהוזן.

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

Method: GET
Type: 
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/agents

דוגמאות נוספות לבקשות ולתגובות:

בקשה לדוגמה: דוגמה לסוכנים

תוכן: אין

דוגמה לתגובה: דוגמה לסוכנים

[
  {
    "id": 45,
    "email": "craigT@nelson.com",
    "roles": [
      "agent"
    ],
    "first_name": "Craig T",
    "middle_name": null,
    "last_name": "Nelson",
    "avatar_url": "https://subdomain.somedomain.com/default-profile.png",
    "agent_number": null,
    "crm_authenticated": false,
    "status": {
      "id": -6,
      "name": "Wrap-up",
      "color": "purple",
    },
    "online": false,
    "wrap_up": false,
    "call_count": 0,
    "chat_count": 0,
    "location": null,
    "created_at": "2016-11-10T00:15:04.000Z",
    "last_login_time": "2016-11-10T00:17:57.000Z",
    "status_updated_at": null,
    "teams": [
      {
        "id": 163,
        "name": "team CTN",
        "parent_id": null,
        "position": 11,
        "agents_count": 12,
        "deleted": false
      }
    ],
    "channels": [
      {
        "channel_type": "voice_call",
        "menu": {
          "id": 2029,
          "name": "Mobile Queue",
          "parent_id": null,
          "position": 0,
          "deleted": false,
          "menu_type": "mobile_menu",
          "output_msg": null,
          "hidden": false
        }
      }
    ]
  },
  {
    "id": 60,
    "email": "notanakinskywalker@empire.com",
    "roles": [
      "agent"
    ],
    "first_name": "Darth",
    "middle_name": null,
    "last_name": "Vader",
    "avatar_url": "https://subdomain.somedomain.com/default-profile.png",
    "agent_number": null,
    "crm_authenticated": false,
    "status": {
      "id": -7,
      "name": "In-call",
      "color": "light_blue",
    },
    "online": false,
    "wrap_up": false,
    "call_count": 0,
    "chat_count": 0,
    "location": null,
    "created_at": "2017-02-03T19:44:14.000Z",
    "last_login_time": "2017-02-03T20:05:31.000Z",
    "status_updated_at": "2017-02-04T12:36:11.000Z",
    "teams": [],
    "channels": [
      {
        "channel_type": "voice_call",
        "menu": {
          "id": 1693,
          "name": "Premium Support",
          "parent_id": null,
          "position": 0,
          "deleted": false,
          "menu_type": "ivr_menu",
          "output_msg": "You selected premium support",
          "hidden": false
        }
      }
    ]
  },
  {
    "id": 81,
    "email": "email@email.com",
    "roles": [
      "agent"
    ],
    "first_name": "Barry",
    "middle_name": null,
    "last_name": "Allen",
    "avatar_url": "https://subdomain.somedomain.com/default-profile.png",
    "agent_number": null,
    "crm_authenticated": false,
    "status": {
      "id": -10,
      "name": "Offline",
      "color": "grey",
    },
    "online": false,
    "wrap_up": false,
    "call_count": 0,
    "chat_count": 0,
    "location": null,
    "created_at": "2017-03-13T23:47:39.000Z",
    "last_login_time": "2017-03-13T23:48:17.000Z",
    "status_updated_at": "2017-03-13T23:56:04.000Z",
    "teams": [],
    "channels": [
      {
        "channel_type": "voice_call",
        "menu": {
          "id": 2028,
          "name": "Speed Issues",
          "parent_id": 2027,
          "position": 0,
          "deleted": false,
          "menu_type": "mobile_menu",
          "output_msg": null,
          "hidden": false
        }
      }
    ]
  }
]

קוד סטטוס: 200

הסטטוס הנוכחי של הנציגים

המדד "הסטטוס הנוכחי של הנציגים" מחזיר את כל הנציגים שמחוברים ואת הסטטוס הנוכחי שלהם, כמה זמן הם נמצאים בסטטוס הזה ומידע נוסף שמציין אם הנציג נמצא בהמתנה ולכמה זמן.

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

Method: GET
Type: 
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/agents/current_status

דוגמאות נוספות לבקשות ולתגובות:

בקשה לדוגמה: הסטטוס הנוכחי של הסוכנים

תוכן: אין

תגובה לדוגמה: הסטטוס הנוכחי של הסוכנים

[
  {
    "id": 1,
    "status": "Available",
    "status_id": 0,
    "status_updated_at": "2021-05-10T17:45:01.000Z",
    "on_hold": false,
    "on_hold_duration": 0
  }
]

קוד סטטוס: 0

צפו למפתחות JSON לא מזוהים בתגובות מה-API

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