Skip to content
aYOUne
← communication API

PhoneLines

Singular: PhoneLine — 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": "6acafff0f43fc235852a8d93",
    "createdBy": "6045f4d25704710012485569",
    "shares": [],
    "createdAt": "2026-10-11T03:18:08.005Z",
    "updatedAt": "2026-10-11T03:18:08.005Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://communication-api.ayoune.app/phonelines/6acafff0f43fc235852a8d93",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "IoTDevices",
        "title": "MODEL_IOTDEVICE",
        "href": "https://api.ayoune.app/config/iotdevices",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.iotdevices"
      },
      {
        "rel": "Credentials",
        "title": "MODEL_CREDENTIAL",
        "href": "https://api.ayoune.app/config/credentials",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.credentials"
      },
      {
        "rel": "BusinessLocations",
        "title": "MODEL_BUSINESSLOCATION",
        "href": "https://api.ayoune.app/config/businesslocations",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.businesslocations"
      }
    ],
    "debugId": "6acafff0f43fc235852a8dc0",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_PHONELINE",
        "href": "https://api.ayoune.app/communication/phonelines/6acafff0f43fc235852a8d93/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_PHONELINE",
        "href": "https://api.ayoune.app/communication/phonelines/6acafff0f43fc235852a8d93",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.18.0",
      "core": "2026.368.0"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "9812",
      "reset": "1791692243",
      "resetDate": "Sun Oct 11 2026"
    },
    "responseTime": 18.030679,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also