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

נקודות הקצה של הסוכן מספקות אמצעי לקבלת אובייקטים של סוכנים. כל אובייקט של סוכן מייצג סוכן יחיד ב-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"
        }
      }
    ]
  }
]

סוכנים

פרמטר	חובה	סוג הנתונים	הגדרה
ייפתח	לא נכון	String	התאמה לכל דף כדי לציין את מספר הדף של הרשומות. לדוגמה, אם הערך של 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

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

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

Body: None

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

[
  {
    "id": 45,
    "email": "[e-mail]",
    "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": "[e-mail]",
    "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": "[e-mail]",
    "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

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

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

Body: None

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

[
  {
    "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 בכל שלב. מומלץ לטפל בתגובות באופן מגן על ידי התעלמות ממפתחות לא מזוהים, כדי לשמור על פונקציונליות רציפה.