SMS-Endpunkte

Die Contact Center AI Platform (CCAI Platform) bietet den Endpunkt Outbound SMS für den SMS-Channel.

Ausgehende SMS

Parameter Erforderlich Datentyp Definition
chat_type TRUE String Der zu erstellende Chattyp. „Messaging (API)“ und „SMS“ (eingestellt) sind vorerst verfügbar Messaging (API)
end_user_number TRUE String Nummer, an die die SMS gesendet werden soll `{end_user_number}`
outbound_number TRUE String Ausgehende Telefonnummer, die zum Senden der SMS-Nachricht verwendet werden soll `{outbound_number}`
Nachricht TRUE String SMS, die an den Nutzer gesendet werden soll `{message}`
ticket_id FALSE String CRM-Ticket-ID, die der Sitzung zugeordnet wird `{ticket_id}`

Endpunkt:

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

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

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

Beispielanfragen und -antworten

In den folgenden Abschnitten finden Sie Beispielanfragen an den Endpunkt.

Ausgehenden SMS-Chat mit Ticket-ID erstellen

In diesem Beispiel wird gezeigt, wie Sie eine ausgehende SMS an einen Endnutzer erstellen, der mit einer Ticket-ID verknüpft ist.

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

{
    "chat_type": "Messaging (SMS)",
    "end_user_number": "+1 415-555-0100",
    "outbound_number": "+1 628-555-0199",
    "message": "lorem ipsum",
    "ticket_id": "5006x00000XXxxxXXX"
}
Antwort: Erstelle einen ausgehenden SMS-Chat mit 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"
}

Statuscode:200

SMS-Chat für ausgehende Nachrichten erstellen und einem Kundenservicemitarbeiter mithilfe der Mitarbeiter-ID zuweisen

In diesem Beispiel wird gezeigt, wie Sie eine ausgehende SMS erstellen, die einem Kundenservicemitarbeiter basierend auf der angegebenen Kundenservicemitarbeiter-ID zugewiesen wird.

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

{
    "chat_type": "Messaging (SMS)",
    "end_user_number": "+1 415-555-0100",
    "outbound_number": "+1 628-555-0199",
    "message": "lorem ipsum",
    "agentId": 1
}
Antwort: Erstelle einen ausgehenden SMS-Chat und weise ihn einem Kundenservicemitarbeiter mit „agentId“ zu.
{
    "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"
}

Statuscode:200

SMS-Chat für ausgehende Nachrichten erstellen und einer Agent-E‑Mail-Adresse zuweisen

In diesem Beispiel wird gezeigt, wie Sie eine SMS-Chatsitzung für ausgehende Nachrichten erstellen und sie einem Kundenservicemitarbeiter zuordnen, indem Sie die E-Mail-Adresse des Kundenservicemitarbeiters angeben.

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

{
    "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"
}
Antwort: Erstelle einen ausgehenden SMS-Chat und weise ihn einem Kundenservicemitarbeiter mit „agentId“ zu.
{
    "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"
}

Statuscode:200

Ausgehenden SMS-Chat ohne Ticket-ID erstellen

In diesem Beispiel wird gezeigt, wie Sie eine ausgehende SMS erstellen, ohne sie einer Ticket-ID zuzuordnen.

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

{
    "chat_type": "Messaging (SMS)",
    "end_user_number": "+1 415-555-0100",
    "outbound_number": "+1 628-555-0199",
    "message": "lorem ipsum",
    "ticket_id": "5006x00000XXxxxXXX"
}
Antwort: Ausgehenden SMS-Chat ohne ticket_id erstellen
{
  "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"
}

Statuscode:200

Fehler : chat_type muss angegeben werden

Dieses Beispiel zeigt das Fehlerszenario, in dem „chat_type“ nicht angegeben wurde, aber erforderlich ist.

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

{
    "end_user_number": "+1 415-555-0100",
    "outbound_number": "+1 628-555-0199",
    "message": "lorem ipsum",
    "ticket_id": "5006x00000XXxxxXXX"
}
Antwort: Fehler : chat_type muss angegeben werden
{
    "message": "chat_type needs to be provided"
}

Statuscode:400

Fehler : Es muss ein gültiger Chattyp angegeben werden.

In diesem Beispiel wird das Fehlerszenario veranschaulicht, in dem der Chattyp angegeben werden muss, aber fehlt.

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

{
    "chat_type": "In-app",
    "end_user_number": "+1 415-555-0100",
    "outbound_number": "+1 628-555-0199",
    "message": "lorem ipsum",
    "ticket_id": "5006x00000XXxxxXXX"
}
Antwort: Fehler : Es muss ein gültiger Chat-Typ angegeben werden.
{
    "message": "valid chat type needs to be provided"
}

Statuscode:400

Fehler : SMS ist nicht aktiviert

In diesem Beispiel wird das Fehlerszenario veranschaulicht, in dem eine ausgehende SMS initiiert wird, SMS jedoch nicht aktiviert ist.

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

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

Antwort: Fehler : SMS ist nicht aktiviert

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

Statuscode:400

Fehler : Ausgehende SMS sind nicht aktiviert

In diesem Beispiel wird das Fehlerszenario veranschaulicht, in dem eine SMS-Sitzung gestartet wird, aber fehlschlägt, weil der SMS-Channel nicht aktiviert ist.

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

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

Antwort: Fehler : Ausgehende SMS sind nicht aktiviert

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

Statuscode:400

Fehler : Endnutzernummer ist erforderlich

In diesem Beispiel wird das Fehlerszenario veranschaulicht, in dem die Endnutzernummer nicht angegeben wurde, aber erforderlich ist.

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

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

Antwort: Fehler : end_user_number ist erforderlich

{
    "message": "end_user_number is required"
}

Statuscode:400

Fehler : Die Endnutzernummer ist ungültig

In diesem Beispiel wird das Fehlerszenario veranschaulicht, in dem die angegebene Endnutzernummer ungültig ist.

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

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

Antwort: Fehler : end_user_number ist ungültig

{
    "message": "end_user_number is invalid"
}

Statuscode:400

Fehler : Nicht US-amerikanische Telefonnummer nicht zulässig

In diesem Beispiel wird das Fehlerszenario veranschaulicht, in dem die angegebene Nummer keine US-Telefonnummer ist und nicht verwendet werden darf.

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

{
    "chat_type": "Messaging (SMS)",
    "end_user_number": "+1 415-555-0100",
    "outbound_number": "+82 000-000-0000",
    "message": "lorem ipsum",
    "ticket_id": "5006x00000XXxxxXXX"
}
Antwort: Fehler : Nicht US-amerikanische Telefonnummer nicht zulässig
{
    "message": "Non-US phone number not allowed"
}

Statuscode:400

Fehler : Die ausgehende Nummer ist erforderlich

In diesem Beispiel wird das Fehlerszenario veranschaulicht, in dem die ausgehende Nummer nicht angegeben wurde, aber erforderlich ist.

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

{
    "chat_type": "Messaging (SMS)",
    "end_user_number": "+1 415-555-0100",
    "message": "lorem ipsum",
    "ticket_id": "5006x00000XXxxxXXX"
}
Antwort: Fehler : outbound_number ist erforderlich
{
    "message": "outbound_number is required"
}

Statuscode:400

Fehler : Die abgehende Nummer ist ungültig

In diesem Beispiel wird das Fehlerszenario veranschaulicht, in dem die angegebene abgehende Nummer ungültig ist.

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

{
    "chat_type": "Messaging (SMS)",
    "end_user_number": "+1 415-555-0100",
    "outbound_number": "12345",
    "message": "lorem ipsum",
    "ticket_id": "5006x00000XXxxxXXX"
}
Antwort: Fehler : outbound_number ist ungültig
{
    "message": "outbound_number is invalid"
}

Statuscode:400

Fehler : outbound_number nicht gefunden

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

{
    "chat_type": "Messaging (SMS)",
    "end_user_number": "+1 415-555-0100",
    "outbound_number": "+1 628-555-0199",
    "message": "lorem ipsum",
    "ticket_id": "5006x00000XXxxxXXX"
}
Antwort: Fehler : outbound_number wurde nicht gefunden
{
    "message": "outbound_number is not found"
}

Statuscode:400

Fehler : Nachricht ist erforderlich

In diesem Beispiel wird das Fehlerszenario veranschaulicht, in dem die Nachricht nicht in den „requires“-Anweisungen angegeben wurde, aber erforderlich ist.

Anfrage

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

{
    "chat_type": "Messaging (SMS)",
    "end_user_number": "+1 415-555-0100",
    "outbound_number": "+1 628-555-0199",
    "message": "",
    "ticket_id": "5006x00000XXxxxXXX"
}
Antwort: Fehler : Nachricht ist erforderlich
{
    "message": "message is required"
}

Statuscode:400

Fehler : Ausgehende SMS fehlgeschlagen. Der Nutzer befindet sich bereits in einer aktiven SMS-Sitzung.

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

{
    "chat_type": "Messaging (SMS)",
    "end_user_number": "+1 415-555-0100",
    "outbound_number": "+1 628-555-0199",
    "message": "lorem ipsum",
    "ticket_id": "5006x00000XXxxxXXX"
}
Antwort: Fehler : Ausgehende SMS fehlgeschlagen. Der Nutzer befindet sich bereits in einer aktiven SMS-Sitzung.
{
    "message": "Outbound SMS failed. Consumer is already in an active SMS session."
}

Statuscode:400