נקודות קצה של SMS

‫Contact Center AI Platform‏ (CCAI Platform) מספקת את נקודת הקצה Outbound SMS לערוץ ה-SMS.

הודעות SMS יוצאות

פרמטר חובה סוג הנתונים הגדרה
chat_type TRUE String סוג הצ'אט שרוצים ליצור. האפשרויות 'הודעות (API)' ו'SMS' (הוצא משימוש) זמינות כרגע הודעות (API)
end_user_number TRUE String המספר שאליו רוצים לשלוח את הודעת הטקסט ‫`{end_user_number}`
outbound_number TRUE String מספר הטלפון היוצא שישמש לשליחת הודעת ה-SMS ‫`{outbound_number}`
הודעה TRUE String הודעת ה-SMS שתישלח לצרכן ‫`{message}`
ticket_id לא נכון String מזהה כרטיס ב-CRM שישויך לסשן ‫`{ticket_id}`

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

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

כותרות:

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

Body:

{
    "chat_type": "Messaging (SMS)",
    "end_user_number": "+1 415-555-0100",
    "outbound_number": "+1 628-555-0199",
    "message": "lorem ipsum",
    "ticket_id": "5006x00000XXxxxXXX"
}

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

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

יצירת צ'אט SMS יוצא עם מספר כרטיס

בדוגמה הזו מוסבר איך ליצור הודעת SMS יוצאת למשתמש קצה שמקושרת למזהה כרטיס.

בקשה

כותרות:

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

Body:

{
    "chat_type": "Messaging (SMS)",
    "end_user_number": "+1 415-555-0100",
    "outbound_number": "+1 628-555-0199",
    "message": "lorem ipsum",
    "ticket_id": "5006x00000XXxxxXXX"
}
תשובה: יצירת צ'אט SMS יוצא עם ticket_id
{
  "id": 114,
  "lang": "en",
  "chat_type": "Messaging (SMS)",
  "status": "selecting",
  "created_at": "2021-10-04T17:20:51.000Z",
  "queued_at": null,
  "assigned_at": null,
  "ends_at": null,
  "wait_duration": 0,
  "chat_duration": 0,
  "rating": null,
  "has_feedback": false,
  "out_ticket_id": null,
  "out_ticket_url": null,
  "verified": false,
  "disconnected_by": "disconnected_by_unknown",
  "fail_reason": null,
  "selected_menu": null,
  "menu_path": null,
  "agent_info": null,
  "end_user": {
    "id": 87,
    "identifier": null,
    "out_contact_id": null
  },
  "photos": [],
  "videos": [],
  "transfers": [],
  "participants": [
    {
      "id": 205,
      "type": "end_user",
      "status": "connected",
      "chat_id": 114,
      "user_id": null,
      "end_user_id": 87,
      "chat_duration": null,
      "connected_at": "2021-10-04T17:20:51.000Z",
      "ended_at": null,
      "fail_reason": "nothing"
    }
  ],
  "offer_type": null,
  "offer_events": [],
  "answer_type": "manual",
  "outbound_number": "+16285550199"
}

קוד הסטטוס: 200

יצירת שיחה עם סוכן באמצעות SMS יוצא והקצאת השיחה לסוכן באמצעות מזהה הסוכן

בדוגמה הזו מוסבר איך ליצור הודעת SMS יוצאת שמוקצית לסוכן על סמך מזהה הסוכן שצוין.

בקשה

כותרות:

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

Body:

{
    "chat_type": "Messaging (SMS)",
    "end_user_number": "+1 415-555-0100",
    "outbound_number": "+1 628-555-0199",
    "message": "lorem ipsum",
    "agentId": 1
}
תשובה: יצירת צ'אט SMS יוצא והקצאה שלו לסוכן באמצעות agentId
{
    "id": 114,
    "lang": "en",
    "chat_type": "Messaging (SMS)",
    "status": "assigned",
    "created_at": "2021-10-04T17:20:51.000Z",
    "queued_at": null,
    "assigned_at": "2021-10-04T17:20:53.000Z",
    "ends_at": null,
    "wait_duration": 0,
    "chat_duration": 0,
    "rating": null,
    "has_feedback": false,
    "out_ticket_id": null,
    "out_ticket_url": null,
    "verified": false,
    "disconnected_by": "disconnected_by_unknown",
    "fail_reason": null,
    "selected_menu": null,
    "menu_path": null,
    "agent_info": {
        "id": 1,
        "agent_number": 9,
        "email": "john.doe@foo.com",
        "name": "John Doe",
        "first_name": "John",
        "last_name": "Doe",
        "avatar_url": "https://foobar.com/johndoe"
    },
    "end_user": {
        "id": 87,
        "identifier": null,
        "out_contact_id": null
    },
    "photos": [],
    "videos": [],
    "transfers": [],
    "participants": [
        {
            "id": 205,
            "type": "end_user",
            "status": "connected",
            "chat_id": 114,
            "user_id": null,
            "end_user_id": 87,
            "chat_duration": null,
            "connected_at": "2021-10-04T17:20:51.000Z",
            "ended_at": null,
            "fail_reason": "nothing"
        },
        {
            "id": 206,
            "type": "agent",
            "status": "connected",
            "chat_id": 114,
            "user_id": 1,
            "end_user_id": null,
            "chat_duration": null,
            "connected_at": "2021-10-04T17:20:53.000Z",
            "ended_at": null,
            "fail_reason": "nothing"
        }
    ],
    "offer_type": null,
    "offer_events": [],
    "answer_type": "manual",
    "outbound_number": "+16285550199"
}

קוד הסטטוס: 200

יצירת צ'אט SMS יוצא והקצאה שלו לכתובת אימייל של סוכן

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

בקשה

כותרות:

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

Body:

{
    "chat_type": "Messaging (SMS)",
    "end_user_number": "+1 415-555-0100",
    "outbound_number": "+1 628-555-0199",
    "message": "lorem ipsum",
    "agentEmail": "john.doe@foo.com"
}
תשובה: יצירת צ'אט SMS יוצא והקצאה שלו לסוכן באמצעות agentId
{
    "id": 114,
    "lang": "en",
    "chat_type": "Messaging (SMS)",
    "status": "assigned",
    "created_at": "2021-10-04T17:20:51.000Z",
    "queued_at": null,
    "assigned_at": "2021-10-04T17:20:53.000Z",
    "ends_at": null,
    "wait_duration": 0,
    "chat_duration": 0,
    "rating": null,
    "has_feedback": false,
    "out_ticket_id": null,
    "out_ticket_url": null,
    "verified": false,
    "disconnected_by": "disconnected_by_unknown",
    "fail_reason": null,
    "selected_menu": null,
    "menu_path": null,
    "agent_info": null,
    "end_user": {
        "id": 87,
        "identifier": null,
        "out_contact_id": null
    },
    "photos": [],
    "videos": [],
    "transfers": [],
    "participants": [
        {
            "id": 205,
            "type": "end_user",
            "status": "connected",
            "chat_id": 114,
            "user_id": null,
            "end_user_id": 87,
            "chat_duration": null,
            "connected_at": "2021-10-04T17:20:51.000Z",
            "ended_at": null,
            "fail_reason": "nothing"
        },
        {
            "id": 206,
            "type": "agent",
            "status": "connected",
            "chat_id": 114,
            "user_id": 1,
            "end_user_id": null,
            "chat_duration": null,
            "connected_at": "2021-10-04T17:20:53.000Z",
            "ended_at": null,
            "fail_reason": "nothing"
        }
    ],
    "offer_type": null,
    "offer_events": [],
    "answer_type": "manual",
    "outbound_number": "+16285550199"
}

קוד הסטטוס: 200

יצירת צ'אט SMS יוצא ללא מזהה כרטיס

בדוגמה הזו מוסבר איך ליצור הודעת SMS יוצאת בלי לשייך אותה למספר כרטיס.

בקשה

כותרות:

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

Body:

{
    "chat_type": "Messaging (SMS)",
    "end_user_number": "+1 415-555-0100",
    "outbound_number": "+1 628-555-0199",
    "message": "lorem ipsum",
    "ticket_id": "5006x00000XXxxxXXX"
}
תגובה: יצירת צ'אט SMS יוצא ללא ticket_id
{
  "id": 114,
  "lang": "en",
  "chat_type": "Messaging (SMS)",
  "status": "selecting",
  "created_at": "2021-10-04T17:20:51.000Z",
  "queued_at": null,
  "assigned_at": null,
  "ends_at": null,
  "wait_duration": 0,
  "chat_duration": 0,
  "rating": null,
  "has_feedback": false,
  "out_ticket_id": null,
  "out_ticket_url": null,
  "verified": false,
  "disconnected_by": "disconnected_by_unknown",
  "fail_reason": null,
  "selected_menu": null,
  "menu_path": null,
  "agent_info": null,
  "end_user": {
    "id": 87,
    "identifier": null,
    "out_contact_id": null
  },
  "photos": [],
  "videos": [],
  "transfers": [],
  "participants": [
    {
      "id": 205,
      "type": "end_user",
      "status": "connected",
      "chat_id": 114,
      "user_id": null,
      "end_user_id": 87,
      "chat_duration": null,
      "connected_at": "2021-10-04T17:20:51.000Z",
      "ended_at": null,
      "fail_reason": "nothing"
    }
  ],
  "offer_type": null,
  "offer_events": [],
  "answer_type": "manual",
  "outbound_number": "+16285550199"
}

קוד הסטטוס: 200

שגיאה : חובה לציין את chat_type

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

בקשה

כותרות:

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

Body:

{
    "end_user_number": "+1 415-555-0100",
    "outbound_number": "+1 628-555-0199",
    "message": "lorem ipsum",
    "ticket_id": "5006x00000XXxxxXXX"
}
תגובה: שגיאה : צריך לציין את chat_type
{
    "message": "chat_type needs to be provided"
}

קוד סטטוס: 400

שגיאה : צריך לספק סוג צ'אט תקין

בדוגמה הזו מוצג תרחיש שבו נדרש לציין את סוג הצ'אט, אבל הוא לא צוין.

בקשה

כותרות:

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

Body:

{
    "chat_type": "In-app",
    "end_user_number": "+1 415-555-0100",
    "outbound_number": "+1 628-555-0199",
    "message": "lorem ipsum",
    "ticket_id": "5006x00000XXxxxXXX"
}
תגובה: שגיאה : צריך לספק סוג צ'אט תקין
{
    "message": "valid chat type needs to be provided"
}

קוד סטטוס: 400

שגיאה : הודעות SMS לא מופעלות

בדוגמה הזו מוצג תרחיש של כשל שבו מתבצעת יציאה של הודעת SMS אבל ה-SMS לא מופעל.

בקשה

כותרות:

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

Body:

{
    "chat_type": "Messaging (SMS)",
    "end_user_number": "+1 415-555-0100",
    "outbound_number": "+1 628-555-0199",
    "message": "lorem ipsum",
    "ticket_id": "5006x00000XXxxxXXX"
}

תגובה: שגיאה : ה-SMS לא מופעל

{
    "message": "SMS is not enabled"
}

קוד סטטוס: 400

שגיאה : לא מופעלת שליחת SMS

בדוגמה הזו אפשר לראות תרחיש שבו סשן SMS מתחיל אבל נכשל כי ערוץ ה-SMS לא מופעל.

בקשה

כותרות:

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

Body:

{
    "chat_type": "Messaging (SMS)",
    "end_user_number": "+1 415-555-0100",
    "outbound_number": "+1 628-555-0199",
    "message": "lorem ipsum",
    "ticket_id": "5006x00000XXxxxXXX"
}

תשובה: שגיאה : שליחת SMS לא מופעלת

{
    "message": "Outbound SMS is not enabled"
}

קוד סטטוס: 400

שגיאה : חובה לציין את מספר המשתמש

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

בקשה

כותרות:

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

Body:

{
    "chat_type": "Messaging (SMS)",
    "outbound_number": "+1 628-555-0199",
    "message": "lorem ipsum",
    "ticket_id": "5006x00000XXxxxXXX"
}

תגובה: שגיאה : חובה לציין את מספר משתמש הקצה

{
    "message": "end_user_number is required"
}

קוד סטטוס: 400

שגיאה : המספר של משתמש הקצה לא תקין

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

בקשה

כותרות:

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

Body:

{
    "chat_type": "Messaging (SMS)",
    "end_user_number": "12345",
    "outbound_number": "+1 628-555-0199",
    "message": "lorem ipsum",
    "ticket_id": "5006x00000XXxxxXXX"
}

תגובה: שגיאה : מספר משתמש הקצה לא תקין

{
    "message": "end_user_number is invalid"
}

קוד סטטוס: 400

שגיאה : אסור להשתמש במספר טלפון שאינו בארה"ב

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

בקשה

כותרות:

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

Body:

{
    "chat_type": "Messaging (SMS)",
    "end_user_number": "+1 415-555-0100",
    "outbound_number": "+82 000-000-0000",
    "message": "lorem ipsum",
    "ticket_id": "5006x00000XXxxxXXX"
}
תגובה: שגיאה : אסור להשתמש במספר טלפון שאינו בארה"ב
{
    "message": "Non-US phone number not allowed"
}

קוד סטטוס: 400

שגיאה : חובה לציין מספר יוצא

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

בקשה

כותרות:

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

Body:

{
    "chat_type": "Messaging (SMS)",
    "end_user_number": "+1 415-555-0100",
    "message": "lorem ipsum",
    "ticket_id": "5006x00000XXxxxXXX"
}
תשובה: שגיאה : חובה לציין מספר יוצא
{
    "message": "outbound_number is required"
}

קוד סטטוס: 400

שגיאה : המספר ליציאה לא תקין

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

בקשה

כותרות:

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

Body:

{
    "chat_type": "Messaging (SMS)",
    "end_user_number": "+1 415-555-0100",
    "outbound_number": "12345",
    "message": "lorem ipsum",
    "ticket_id": "5006x00000XXxxxXXX"
}
תגובה: שגיאה : outbound_number לא תקין
{
    "message": "outbound_number is invalid"
}

קוד סטטוס: 400

שגיאה : לא נמצא מספר יוצא

כותרות:

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

Body:

{
    "chat_type": "Messaging (SMS)",
    "end_user_number": "+1 415-555-0100",
    "outbound_number": "+1 628-555-0199",
    "message": "lorem ipsum",
    "ticket_id": "5006x00000XXxxxXXX"
}
תגובה: שגיאה : לא נמצא מספר יוצא
{
    "message": "outbound_number is not found"
}

קוד סטטוס: 400

שגיאה : חובה להזין הודעה

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

בקשה

כותרות:

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

Body:

{
    "chat_type": "Messaging (SMS)",
    "end_user_number": "+1 415-555-0100",
    "outbound_number": "+1 628-555-0199",
    "message": "",
    "ticket_id": "5006x00000XXxxxXXX"
}
תגובה: שגיאה : חובה לציין הודעה
{
    "message": "message is required"
}

קוד סטטוס: 400

שגיאה : שליחת ה-SMS נכשלה. הלקוח כבר נמצא בסשן פעיל של SMS.

כותרות:

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

Body:

{
    "chat_type": "Messaging (SMS)",
    "end_user_number": "+1 415-555-0100",
    "outbound_number": "+1 628-555-0199",
    "message": "lorem ipsum",
    "ticket_id": "5006x00000XXxxxXXX"
}
תשובה: שגיאה : שליחת ה-SMS היוצא נכשלה. הלקוח כבר נמצא בסשן פעיל של SMS.
{
    "message": "Outbound SMS failed. Consumer is already in an active SMS session."
}

קוד סטטוס: 400