aYOUne
← communication API

UserPresences

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

play_circle 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": "6a94fd3ee2e6f0a33374380e",
    "_user": "6045f4d25704710012485569",
    "status": "offline",
    "statusMessage": "UNHAPPY_MAGENTA_TAUN WE",
    "isDraft": true,
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2026-08-31T04:04:14.148Z",
    "updatedAt": "2026-08-31T04:04:14.148Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://communication-api.ayoune.app/userpresences/6a94fd3ee2e6f0a33374380e",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Devices",
        "title": "MODEL_DEVICE",
        "href": "https://api.ayoune.app/communication/devices",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "communication.devices"
      },
      {
        "rel": "Calls",
        "title": "MODEL_CALL",
        "href": "https://api.ayoune.app/communication/calls",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "voice.calls"
      }
    ],
    "debugId": "6a94fd3fe2e6f0a33374384a",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_USERPRESENCE",
        "href": "https://api.ayoune.app/communication/userpresences/6a94fd3ee2e6f0a33374380e/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_USERPRESENCE",
        "href": "https://api.ayoune.app/communication/userpresences/6a94fd3ee2e6f0a33374380e",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.18.0",
      "core": "2026.319.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2434",
      "reset": "1788152648",
      "resetDate": "Mon Aug 31 2026"
    },
    "responseTime": 193.975345,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

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

Weiterführend