Skill-Liste abrufen

Ermöglicht das Abrufen der Skill-Liste innerhalb einer bestimmten Organisation.

Über diese Schnittstelle können Sie die Skill-Liste innerhalb einer bestimmten Organisation abrufen.

Anfragemethode

GET

Anfrage-URL

https://api.${endpoint}/v1/org/skill/list

Authentifizierung der Anfrage

Basic-Authentifizierung mit DevKey / DevSecret auf Kontoebene.

Anfrage

Beispielanfrage

curl -X GET 'https://api.${endpoint}/v1/org/skill/list?org_id=p-xxxx&keyword=refund&owner_type=ORGANIZATION&enable=true' \ -H 'Authorization: Basic ${BASIC_TOKEN}'

                      
                      curl -X GET 'https://api.${endpoint}/v1/org/skill/list?org_id=p-xxxx&keyword=refund&owner_type=ORGANIZATION&enable=true' \
  -H 'Authorization: Basic ${BASIC_TOKEN}'

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Basic ${BASIC_TOKEN}	Basic Token als Base64-Kodierung von `DevKey:DevSecret`.
Locale	String	Optional. Sprache der Antworttexte, Standard `en_US`.

Anfrageparameter (Query Parameters)

Parameter	Typ	Beschreibung	required
org_id	String	Organisations-ID.	true
keyword	String	Schlüsselwort.	false
category_id	String	ID der Skill-Kategorie.	false
owner_type	String	Zugehörigkeitstyp des Skill, z. B. `ORGANIZATION`.	false
owner_agent_id	String	Agent-ID, zu der der private Skill gehört.	false
enable	Boolean	Ob nur aktivierte oder deaktivierte Skill zurückgegeben werden.	false

Antwort

Beispielantwort

{ "code": 0, "message": "OK", "data": [ { "id": "skill-xxxx", "name": "refund-policy", "display_name": "退款政策", "owner_type": "ORGANIZATION", "enable": true } ] }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": [
    {
      "id": "skill-xxxx",
      "name": "refund-policy",
      "display_name": "退款政策",
      "owner_type": "ORGANIZATION",
      "enable": true
    }
  ]
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Die Antwortelemente übernehmen die Felder der Skill-Liste aus der Konsole und enthalten unter anderem Skill-ID, Name, Beschreibung, Zugehörigkeit, Kategorie, Version und Aktivierungsstatus.

Fehlerantwort

Feld	Typ	Beschreibung
code	Integer	Fehlercode.
message	String	Fehlerdetails.

Statuscodes

Statuscode	Beschreibung
200	Erfolgreich
400	Ungültige Parameter
401	Nicht autorisiert
403	Unzureichende Berechtigungen
429	Zu viele Anfragen
500	Serverfehler