Zum Inhalt springen
aYOUne
← communication API

IVRFlows

Singular: IVRFlow — Base-URL: https://communication-api.ayoune.app — Zugriff: CRUD — Maschinenlesbare Beschreibung (JSON · YAML)

Jetzt ausprobieren beta

Requests werden über den consumer-app Proxy an *.ayoune.app weitergeleitet. Tokens bleiben im Browser und werden pro Call mitgesendet.

Beispiel-Response (aufgezeichnet) Beispiel

Eine echte, zuvor aufgezeichnete GET /:id-Antwort dieses Endpunkts — nicht der Live-Call oben. Sensible Felder sind maskiert.

{
  "payload": {
    "_id": "6ad82fc83070371ccd0adca8",
    "name": "CHIEF_AQUAMARINE_EETH KOTH",
    "active": false,
    "createdBy": "6045f4d25704710012485569",
    "shares": [],
    "createdAt": "2026-10-21T03:21:44.373Z",
    "updatedAt": "2026-10-21T03:21:44.373Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://communication-api.ayoune.app/ivrflows/6ad82fc83070371ccd0adca8",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "AutomationWorkflows",
        "title": "MODEL_AUTOMATIONWORKFLOW",
        "href": "https://api.ayoune.app/automation/automationworkflows",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "automation.automationworkflows"
      },
      {
        "rel": "PhoneNumbers",
        "title": "MODEL_PHONENUMBER",
        "href": "https://api.ayoune.app/communication/phonenumbers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "voice.phonenumbers"
      },
      {
        "rel": "Websites",
        "title": "MODEL_WEBSITE",
        "href": "https://api.ayoune.app/cms/websites",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "cms.websites"
      },
      {
        "rel": "CallAgents",
        "title": "MODEL_CALLAGENT",
        "href": "https://api.ayoune.app/communication/callagents",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "voice.callagents"
      }
    ],
    "debugId": "6ad82fca3070371ccd0adcee",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_IVRFLOW",
        "href": "https://api.ayoune.app/communication/ivrflows/6ad82fc83070371ccd0adca8/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_IVRFLOW",
        "href": "https://api.ayoune.app/communication/ivrflows/6ad82fc83070371ccd0adca8",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.18.0",
      "core": "2026.387.1"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "9875",
      "reset": "1792556474",
      "resetDate": "Wed Oct 21 2026"
    },
    "responseTime": 263.390988,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

MethodePathBeschreibungRight
GET /ivrflows Liste mit Filtern/Paginierung voice.ivrflows.view
GET /ivrflows/:id Einzelner Datensatz voice.ivrflows.view
POST /ivrflows Neuen Datensatz erstellen voice.ivrflows.new
PUT /ivrflows Datensatz aktualisieren voice.ivrflows.edit
DELETE /ivrflows/:id Datensatz löschen voice.ivrflows.delete

SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

// Alle abrufen
const list = await ay.communication.iVRFlows.find().limit(10).exec();

// Einzelnen Datensatz
const one = await ay.communication.iVRFlows.findById('OBJECT_ID').exec();

// Erstellen
const created = await ay.communication.iVRFlows.create({ name: 'Foo' });

Weiterführend