Repository navigation
Releases
Releases · WireCatLabs/asterisk-cli
0.9.0
Added
pbx <profile> account removesigns a profile out and forgets it on this computer. It forgets the saved
database or SFTP password and the profile's settings.--keep-dataleaves its calls in the store, where search still
finds them;--delete-datadeletes them. It asks first, or takes--yes;--dry-runlists what it would remove.
Why: WireCat Desktop removes an account with this command, and pbx could only sign out withsession end. The
password itself stays valid on the server: only the server's owner changes it.
Changed — may break callers
- The MCP Registry entry asks which profiles to serve. It started
mcp serve --profiles all, so a client that
installed the server from the registry reached every account on the computer without the owner choosing. Now
--profilesis a required argument with the examplepersonal: the client asks for one profile, a
comma-separated list orall. Why: a CLI never picks an account for the owner
(WC-MCP-9). Watch for: a client set up from the old entry keeps--profiles alluntil it is set up again; a
server added by hand or withmcp configdoes not change.
Fixed
- WireCat Desktop can remove a pbx account. The manifest Desktop reads (
contracts/wirecat.json) now names
account removeandsession end.
0.8.0
Changed — may break callers
meetings transcribeanswers the same report as the other phone CLIs (beeline, b24). The audio time is
audio_ms, in milliseconds (wasaudio_seconds). Each failed call has itsref. A call with no recording is listed
underfailedwith the reasonrecording.missing, andwithout_recordingis gone.
0.7.2
Fixed
- A call shows its direction, the employee and the caller's number in
memo contextand WireCat Desktop.pbx
kept them only in the call's details, so other tools showed a call as a bare title. A call synced before this
version gets them on a sync that reads it again:pbx office meetings sync --since-time <the first call's date>.
An internal call, between two extensions, has none. See what you get from each call.
0.7.1
Fixed
- A sync no longer prints the note about
asterisk.users. On a MySQL source that may not read FreePBX's
asterisk.users, as on a plain Asterisk, every sync printed that the extension names were not read, cron runs too.
Now the check inpbx office setup,session startandsession status --checkprints the note once, where you
are looking, and a sync stays quiet. A grant given later works on the next sync. See
names of the extensions. - The docs say WireCat Desktop plays a call's recording. Desktop plays it on the call's card when the recordings
folder is on this computer, and the linkmeetings showprints opens the call. A recording read over SFTP stays on
the phone system.
0.7.0
Added
pbx office setupconnects a profile question by question, and WireCat Desktop draws the same flow. It asks
where the call records are (Master.csv, MySQL or MariaDB, PostgreSQL), whether the files are on this computer or
on the PBX over SFTP, the database through the PBX's SSH server when it listens only there, the recordings folder
and the countries of the phone lines. It reads the newest hour of calls to check the answers, the same check as
session start, and saves the settings and the passwords only when that works. A refused password or setting
takes it back to the step that has it.setup show --json,setup apply --dry-runand
setup run apply --answer-stdingive the same flow to WireCat Desktop, in English, Russian and Spanish. See
install and connect.- A changed server never gets the old password. When
setupchanges a database, SSH or SFTP server, its port,
its user, or the source, a password left empty is refused (validation_error,paramnames the input) instead
of the kept one being tried on the new place. - An unconnected profile points to
setup. The message of a profile that was never connected, and the first
screen ofpbx, namepbx <profile> setup. extension_namesnames the employees who never place a call. Set it as101=Anna Smirnova,103=Vera Orlova,
or inpbx office setupand WireCat Desktop. Before, an extension got a name only from the caller ID of a call it
placed, sostats calls showlisted an employee who only answers as a bare number. A name set here wins. See
names of the extensions.- FreePBX's own names of the extensions. On a FreePBX MySQL,
pbxreadsasterisk.userswith the same database
user, the two columnsextensionandnameonly, so the admin grants access to those columns and never to the
phones' passwords in the same table. A user without that grant syncs as before; each sync prints one note. The order:
extension_names, then FreePBX, then the caller ID.
Changed — may break callers
phone_regionalso takes a list. The setup flow keeps the chosen countries as a list (["RU","ES"]), and
config set phone_region es,runow does too. A comma-separated text set earlier reads as before.
Fixed
- A sync no longer drops an extension's name from a call it reads again. When the records read this time held no
call that named the extension, the call kept no name for it; it now keeps the name it was saved with.
0.6.1
Fixed
session startno longer waits for ever on a pipe that stays open. It reads one line per password it needs and
stops there, so a program that keeps stdin open after the last password, as WireCat Desktop once did, gets its
answer. A pipe that sends nothing gives up after 30 seconds with "no password was given".- A profile that was never connected says so.
meetings syncand the other commands that read the phone system
no longer ask forcdr_csv_pathon a profile with no source settings of its own. They say the profile is not
connected, point to install and connect, and list the profiles on this computer. A
profile that chosecdr_source csvstill gets the missing setting by name. The reason stays
source.not-configured. - The docs: troubleshooting names the reason
network.failed, as the error gives it; the settings and security
pages have a contents list; the MCP server, the run record and the files on this computer have their own sections
on the security page, out of "Recordings and consent"; two code spans no longer break across a line.
0.6.0
Added
stats calls showcounts the stored calls. It gives the calls by direction and outcome, per employee, by hour
and by day, the missed incoming calls and whether the client was called back, and the short calls. It reads only
the local store. See a report of the week.search meetingsfinds a call by what was said. By words, and with--model embeddinggemmaby meaning too,
with a text model on this computer.meetings embed --yesbuilds the search data ahead of time, one batch per run.
models listandmodels downloadnow also offer the text models. See
find calls by what was meant.tags add,tags removeandtags listmark calls.tags add complaint --matching "refund OR complaint"
marks every call the search finds, and a rerun marks only the new ones;--meeting <id>marks one call. See
mark every call about refunds.- A database that listens only on the phone system is reached through its SSH. Set
db_ssh_host,db_ssh_user
and a key file indb_ssh_key_path, or a password; the server's key is pinned indb_ssh_host_keyfirst.pbx
opens the tunnel for each command and closes it after. See
a database behind the phone system's SSH. - A profile can keep more than one password. A database profile can sign in to SFTP or SSH with a password too.
session startasks each password it needs; piped, one per line. They are kept in the profile's one keyring
entry. - Cloud transcription, for one profile at a time.
config set transcribe_engine openaisends the speech of the
recordings to OpenAI in place of the local model, with the key inOPENAI_API_KEY. The run says where the audio
goes before the first piece leaves. It stays off unless the profile's own settings turn it on. See
cloud transcription. meetings showprints a WireCat Desktop link for the call in the terminal,wirecat://open/v1/meeting/…. It
opens the call once Desktop supports links to calls.meetings shownames each recording's file on this computer inlocal_path, so WireCat Desktop can play it.
It isnullwhen the recording is read over SFTP. This comes with cli-core 0.668.0.- Master.csv and the recordings of any size over SFTP. They are read in pieces, and a connection that breaks is
opened again where it stopped. A recording on the phone system is copied into a private temporary file for the
time it is read, and deleted after. A WAV, GSM or M4A recording of any size is transcribed, up to an hour of audio. - A stereo WAV, GSM or M4A recording keeps its two channels, so
recordings_channelsnames the caller and the
employee on each line for these formats too.
Changed — may break callers
- A stereo WAV, GSM or M4A call is transcribed as two channels. Its lines say
Channel 1andChannel 2, or the
namesrecordings_channelsgives, where they were one mixed text.meetings transcribe --replacedoes it for the
calls already transcribed. - An MP3, Ogg or FLAC recording can be up to 64 MB, not 256 MB. That is more than an hour at usual phone quality,
and a recording longer than an hour was never transcribed. - The run record names the database's requests
sql.connect,sql.columnsandsql.rows, notcdr.connect,
cdr.columnsandcdr.rows. A database that does not answer in time now has the reasondb.timeout, and one that
cannot be reachednetwork.failed.
0.5.0
Added
- A transcript can name who said each line. Set
recordings_channelstocaller,employeeoremployee,caller,
as your dialplan records the two sides, and each line of a stereo MP3, Ogg or FLAC recording names the caller by
name and number, or the employee by extension and name. Without the setting the lines sayChannel 1and
Channel 2, as before.meetings transcribe --replacelabels the calls already transcribed. A call imported by
an earlier version gets the caller's number in its label only after a sync reads it again: runmeetings sync
with--since-timeat your first call before--replace. A WAV, GSM or M4A recording is still one mixed track.
See transcribe. - Master.csv of any size. A
Master.csvon this computer or in a mounted folder is read line by line, so a file
over 512 MB is no longer refused, and only the calls a sync needs stay in memory. Over SFTP it is still read whole,
up to 512 MB. - Hour-long recordings in WAV, GSM and M4A. These recordings can be up to 2 GB, instead of 256 MB, so an hour of
48 kHz stereo WAV is transcribed. Every recording can still be up to one hour, and MP3, Ogg and FLAC up to 256 MB. - A call's metadata keeps the caller's number as
client, the same form as in its title.
Changed — may break callers
meetings listandmeetings showtake--backend archive|server|both(cli-core 0.663.0, was 0.656.0).
pbx does not ask Asterisk from these commands, so both answer from the store and say so inmissing.
meetings showtakes the call's number, itsmeeting:ref or Asterisk's own id.- The
meetingsandeventscommands take the program's--json [fields]and--jsonl. They no longer have
on/off flags of their own, someetings list --json id,titlekeeps those fields. - A list without
--limitshows the profile'sdefaults.limit, 20 unless set. This holds formeetings list,
events list,search meetingsandruns list; the meetings lists showed 100 before. - A list query's dates read the computer's zone, not UTC (
started_at:today). - A
readonlylevel no longer stopsmeetings sync. It only copies call records into the local store;deny
still refuses it. - Every time flag takes one grammar (cli-base 0.100.0, was 0.98.0): ISO with or without seconds and zone, a date
alone,today,yesterday, or30m,2h,7dago.meetings sync --since-time 2hnow works.
Fixed
- The README's limits and the overview's "What it does not do yet" say first what you can do, then what not, in
plain words: the three call record sourcespbxreads, SFTP and the one saved password, who said what in mono
and stereo recordings, and the sizes. Install and connect
names the Countries of your phone lines field of WireCat Desktop's connect form.
0.4.0
Added
- Each call's description says what became of it, for
meetings show, WireCat Desktop and an agent:Incoming call to 600: answered by 101 Анна Смирнова after 0:03, talk 0:24. 102 Борис Кузнецов did not answer. phone_regiontakes several countries,es,ru, for an office whose phone lines serve more than one. A number
written without+is read in the country it fits; one that fits two of them is kept as written, linked to no
one, andmeetings syncsays how many callers that left. See
numbers, directions and people.
Changed — may break callers
- One call is one meeting. Every CDR row of a call (a ring group's members, a queue, a transfer) is joined by its
linkedid, and the meeting's id is thatlinkedid. Its people are the caller, the employee who placed it and each
one who answered; its metadata says what became of it (outcome: answered, voicemail, busy, no_answer, failed),
who placed it (placedBy), who answered (answeredBy), who rang without answering (rang), what was dialled,
the wait before the first answer (waitMs), the talk time (talkMs) and every leg. The one-row meetings of 0.3.0 and older are marked
deleted once a sync reads their rows again into a call;meetings sync --since-time <first call>reads them all.
A transcript made of a row meeting is made again bymeetings transcribe. - An employee's identity is now
extension:<profile>/<number>(wasextension:<number>), so extension 101 of one
profile and 101 of another are two people, not one. A script that looked people up byextension:101adds the
profile:extension:office/101. - A ring group's or queue's member who answered is named by the channel that reached them (
Local/101@…), not by the
group's number (600), and employees are named from the caller ID of the calls they make. meetings show --jsonanswers{ "item": { … } }; 0.3.0 wrapped the meeting twice, asitem.item.- Built on cli-core 0.656.0 (was 0.648.0). See the
cli-core changelog.
Fixed
- WireCat Desktop and the README link to the guide on wirecat.dev, now that it is
published, instead of the README on GitHub. - A caller is linked to the CRM contact or messenger person with the same mobile number, as Beeline's are: the
caller's participant now carries its phone number. - A recording with nothing but its header, which MixMonitor leaves when nobody talked, is no longer linked or sent to
transcription. - A build starts from an empty
dist/, so a renamed file no longer ships: 0.3.0 carried an unused
dist/bin/asterisk.js. - Sync runs on a fresh install. A shared WireCat config (
~/.config/WireCat/config.json) that could not be
read (a byte-order mark, broken JSON, a folder in its place, an oldersetupshape) made every WireCat tool
read-only and refusedsync. Now only the owner's own "read only" answer limits a tool, and even then a sync runs:
it only reads the service into the local store (cli-core 0.656.0). - The guide starts with what you get from your calls and the work an agent can take over: the overview says what
pbxdoes and does not do yet, install and connect is one page from installation to
the first sync, in WireCat Desktop or a terminal, and use it is built around a team's daily
tasks, with requests to copy and a schedule.
0.3.0
Changed — may break callers
- The command is now
pbx, also installed aswcat-pbx.asteriskhid the PBX's own program on a server that runs
both. Variables start withPBX_(PBX_PROFILE,PBX_READ_ONLY), the MCP entry ispbx-<profile>, and its tools
arepbx_read,pbx_writeandpbx_tools_search. The package, its settings and the saved passwords keep the name
asterisk-cli, so nothing is set up again.