---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# CCCIF-Medienressourcen-API

# CCCIF-Medienressourcen-API {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 Minuten Lesedauer

Die Anwenderdefinierte Medienressource für Chat-Chatbot-Interoperabilitäts-Framework (CCCIF) Die API stellt Endpunkte bereit, mit denen ein primärer Bot Anhänge in die zugeordnete hochladen kann ServiceNowInstanz.
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](https://servicenow-prod.fluidtopics.net/vrZYWu2jPtsNSa496Umhqw#bot-api "Die Virtual Agent-Bot-Integration Die API stellt Endpunkte bereit, mit denen Anwender jede Chat-Schnittstelle oder ein Bot-Ökosystem in integrieren können ServiceNow Virtual AgentUnd/oder Servicemitarbeiter.")Rufen Sie an.

Um auf diese API zuzugreifen, muss das Plugin „Konversationsanwenderdefinierte Chatintegration" (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 AgentAPI, siehe [Virtual Agent-API](https://www.servicenow.com/docs/access?context=virtual-agent-api&version=yokohama&pubname=yokohama-conversational-interfaces&ft:locale=en-US).

## CCCIF: /Cccif/Media/upload POSTEN {#ariaid-title2}

Lädt einen privaten Anhang zu hoch ServiceNowInstanz, 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 [API für Virtual Agent-Bot-Integration](https://servicenow-prod.fluidtopics.net/vrZYWu2jPtsNSa496Umhqw#bot-api "Die Virtual Agent-Bot-Integration Die API stellt Endpunkte bereit, mit denen Anwender jede Chat-Schnittstelle oder ein Bot-Ökosystem in integrieren können ServiceNow Virtual AgentUnd/oder Servicemitarbeiter.").

### 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](https://servicenow-prod.fluidtopics.net/QZyr9s_~V0xB9fqGOlvJ4A "In diesem Tutorial verwenden Sie den REST API Explorer, um zu testen ServiceNowREST-APIs."). Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf [Geskriptetes REST-Service-Formular](https://servicenow-prod.fluidtopics.net/0V9QfkPsOI5r~YAD7CJWCA "Mit der geskripteten REST-API-Funktion können Anwendungsentwickler anwenderdefinierte Webservice-APIs erstellen.").

### Unterstützte Anforderungsparameter

{#cccif-media-upload__entry__2}{#cccif-media-upload__version-not_optional-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: <kbd class="ph userinput">v1 </kbd>Oder <kbd class="ph userinput">v2 </kbd>. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
[Tabelle : 1. Pfad-Parameter]

{#cccif-media-upload__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 2. Abfrageparameter]

{#cccif-media-upload__entry__10}

| 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-Anbieteranwendung |
| 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 |
[Tabelle : 3. Anforderungstext-Parameter]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#cccif-media-upload__entry__18}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: multipart/form-data. |
[Tabelle : 4. Anforderungskopfzeilen.]

{#cccif-media-upload__entry__22}

| Header | Beschreibung |
|-|-|
| Inhaltstyp | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 5. Antwort-Header]

### 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](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#cccif-media-upload__entry__26}{#cccif-media-upload__entry-400-status-code}{#cccif-media-upload__entry-401-status-code}{#cccif-media-upload__entry-404-status-code}{#cccif-media-upload__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 201 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen 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. Die Antwort enthält zusätzliche Informationen zum Fehler. |
[Tabelle : 6. Statuscodes]

### Antworttext-Parameter (JSON)

{#cccif-media-upload__entry__38}

| 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 |
| Staat | Status des Anhangs in der Anhangstabelle. Mögliche Werte: * Verfügbar * Bedingt verfügbar * nicht verfügbar * Ausstehend {#cccif-media-upload__ul_mxv_yjp_trb} 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"
      }


