← API Reference

communication API

Base URL: https://communication-api.ayoune.app — 14 entities

Example

cURL

curl -H "Authorization: Bearer pat_your_token" \
  https://communication-api.ayoune.app/callagentassignments?limit=10

TypeScript SDK

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

const result = await ay.communication.callAgentAssignments.find().limit(10).exec();
console.log(result.payload());

Entities

Entity	REST Path	SDK	Access	Right
CallAgentAssignments	/callagentassignments	ay.communication.callAgentAssignments	CRUD	voice.callagentassignments	play_circle
CallAgents	/callagents	ay.communication.callAgents	CRUD	voice.callagents	play_circle
CallEvents	/callevents	ay.communication.callEvents	read-only	voice.callevents	play_circle
CallQueues	/callqueues	ay.communication.callQueues	CRUD	voice.callqueues	play_circle
Calls	/calls	ay.communication.calls	read-only	voice.calls	play_circle
CallScorecards	/callscorecards	ay.communication.callScorecards	read-only	voice.qa.scorecards	play_circle
CallTranscripts	/calltranscripts	ay.communication.callTranscripts	read-only	voice.calltranscripts	play_circle
Devices	/devices	ay.communication.devices	CRUD	communication.devices	play_circle
IVRFlows	/ivrflows	ay.communication.iVRFlows	CRUD	voice.ivrflows	play_circle
OptInRecords	/optinrecords	ay.communication.optInRecords	CRUD	voice.optinrecords	play_circle
PhoneNumbers	/phonenumbers	ay.communication.phoneNumbers	CRUD	voice.phonenumbers	play_circle
UserPresences	/userpresences	ay.communication.userPresences	CRUD	communication.userpresences	play_circle
VoiceBundleRequests	/voicebundlerequests	ay.communication.voiceBundleRequests	CRUD	voice.bundlerequests	play_circle
VoicePortRequests	/voiceportrequests	ay.communication.voicePortRequests	CRUD	voice.portrequests	play_circle