Skip to content
aYOUne
← communication API

IVRFlows

Singular: IVRFlow — Base URL: https://communication-api.ayoune.app — Access: CRUD — Machine-readable spec (JSON · YAML)

Try it now beta

Requests are proxied through the consumer-app to *.ayoune.app. Tokens stay in your browser and are forwarded per call.

Example response (recorded) sample

A real, previously recorded GET /:id response of this endpoint — not the live call above. Sensitive fields are masked.

{
  "payload": {
    "_id": "6adc24551acf9a28b2e711d0",
    "name": "EMPTY_AQUA_BIGGS DARKLIGHTER",
    "active": false,
    "createdBy": "6045f4d25704710012485569",
    "shares": [],
    "createdAt": "2026-10-24T03:21:57.735Z",
    "updatedAt": "2026-10-24T03:21:59.340Z",
    "modifiedBy": "6045f4d25704710012485569"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://communication-api.ayoune.app/ivrflows/6adc24551acf9a28b2e711d0",
        "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": "6adc24571acf9a28b2e71223",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_IVRFLOW",
        "href": "https://api.ayoune.app/communication/ivrflows/6adc24551acf9a28b2e711d0/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_IVRFLOW",
        "href": "https://api.ayoune.app/communication/ivrflows/6adc24551acf9a28b2e711d0",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.18.0",
      "core": "2026.388.0"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "9870",
      "reset": "1792815661",
      "resetDate": "Sat Oct 24 2026"
    },
    "responseTime": 297.237094,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

MethodPathDescriptionRight
GET /ivrflows List with filters/pagination voice.ivrflows.view
GET /ivrflows/:id Single record voice.ivrflows.view
POST /ivrflows Create new record voice.ivrflows.new
PUT /ivrflows Update record voice.ivrflows.edit
DELETE /ivrflows/:id Delete record voice.ivrflows.delete

SDK

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

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

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

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

See also