CCCIF-Medienressourcen-API

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 2 Minuten Lesedauer

    • Die Anwenderdefinierte CCCIF-Medienressource (Chat Chatbot Interoperability Framework) Die API stellt Endpunkte bereit, mit denen ein primärer Bot Anhänge in den zugehörigen hochladen kann ServiceNow Instanz.

    Rufen Sie diese API in Ihrem primären Bot auf, um private Anhänge von einem Anwender hochzuladen, der eine Konversation über führt Virtual Agent(VA). Sie müssen dann senden MediaUrl Parameter, der von dieser API an die VA-API zurückgegeben wird.

    Wenn der Anhang öffentlich ist, können Sie einfach die Anhang-URL im Anforderungstext von senden Virtual Agent-Bot-Integration Rufen Sie an.

    Um auf diese API zuzugreifen, muss das Plugin „Conversational Custom Chat Integration“ (com.Glide.cs.custom.Adapter) aktiviert sein. Darüber hinaus müssen die Systemeigenschaften des Anhangs konfiguriert werden.

    Für zusätzliche Informationen zu den Fähigkeiten von Virtual Agent API, siehe Virtual Agent-API .

    CCCIF: VERÖFFENTLICHEN SIE /cccif/Media/upload

    Lädt einen privaten Anhang in den angerufenen hoch ServiceNow Instanz, die den Anhang in der Tabelle „Anhänge“ [sys_attachment] speichert.

    Rufen Sie diese Methode in Ihrem primären Bot auf, um private Anhänge von einem Anwender hochzuladen, der eine Konversation über führt Virtual Agent(VA). Sie müssen dann senden MediaUrl Parameter, der von dieser Methode mit an die VA-API zurückgegeben wird Virtual Agent-Bot-Integrations-API.

    URL-Format

    Versionierte URL: /api/now/{api_Version}/cccif/Media/upload

    Standard-URL: /api/now/cccif/Media/upload

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 3. Anforderungstextparameter
    Name Beschreibung
    file Erforderlich. Pfad der hochzuladenden Datei.

    Datentyp: Zeichenfolge, z. B. @File PATH <file_path>
    Provider_Application_ID SYS_ID der sys_cs_Provider_Application, die mit dem VA-Bot interagiert.

    Standard: SYS_ID der VA-Bot-zu-Bot-Provider-Anwendung
    user_id Erforderlich. Eindeutiger Anwenderbezeichner des Anwenders, der mit dem VA-Bot interagiert. Dies kann eine beliebige Zeichenfolge sein, die für jeden Anwender eindeutig ist.

    Datentyp: Zeichenfolge

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 4. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: multipart/form-data.
    Tabelle : 5. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Inhaltstyp Datenformat des Antworttexts. Unterstützt nur application/json.

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    201 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    attachmentId SYS_ID des Anhangs, der gespeichert wurde.

    Datentyp: Zeichenfolge
    Fehler Beschreibung eines Fehlers, der bei der Verarbeitung der Anforderung erkannt wurde.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Details zum aufgetretenen Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Nachricht, die den ausgelösten Fehler beschreibt.

    Datentyp: Zeichenfolge
    mediaUrl Anhang-URL, die an den primären Bot gesendet werden soll, um auf den Anhang zuzugreifen. Der primäre Bot muss diese URL in senden message.attachment.urlParameter des Anforderungstexts von VERÖFFENTLICHEN SIE /sn_va_as_Service/bot/Integration Endpunkt.

    Datentyp: Zeichenfolge
    name Dateiname des Anhangs.

    Datentyp: Zeichenfolge
    Status Status des Anhangs in der Tabelle „Anhang“.
    Mögliche Werte:
    • Verfügbar
    • Bedingt verfügbar
    • Nicht verfügbar
    • Ausstehend

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Dieses Beispiel zeigt, wie ein PNG-Dateianhang hochgeladen wird.

    curl --location --request POST 'https://instance.servicenow.com/api/now/v1/cccif/media/upload' \
--header 'Authorization: Basic xxxxxxxxxxxxx' \
--header 'Content-Type:multipart/form-data' \
--form 'user_id="lincoln"' \
--form 'file=@"/Users/Desktop/Screenshot 2021-10-25 at 5.08.14 PM.png"'

    Antwort:

    Response :{
  "result": {
    "mediaUrl": "https://instance.servicenow.com/api/now/v1/cs/media/vGfewkfAv0VBo2RxmlTM448L789Pp6rqLFLUNYQxZsUUFrsgMA8aW9W0zWx1a5fG",
    "name": "Screenshot 2021-10-25 at 5.08.14 PM.png",
    "state": "pending",
    "attachmentId": "299c648887b73c1022b6a6cd0ebb3534"
  }