#!/bin/sh | |
# sendmail-gcloud | |
# | |
# Installation instructions | |
# Copy the content of this file to /usr/sbin/sendmail-gcloud | |
# | |
# Google Account | |
# --------------- | |
# Create a Google Cloud account if you don't have one yet. Free trial is available at https://console.cloud.google.com/freetrial | |
# Within console.cloud.google.com search for Cloud Speech-to-Text API and enable it | |
# | |
# From the Linux command line on the FreePBX machine | |
# ------------------------------------------- | |
# Follow steps 1 and 2 of the instructions on Google Cloud https://cloud.google.com/sdk/docs/downloads-yum | |
# Run the following commands on FreePBX; | |
# cd /usr/sbin/ | |
# chown asterisk:asterisk sendmail-gcloud | |
# chmod 744 sendmail-gcloud | |
# chmod 777 /usr/bin/dos2unix | |
# | |
# Verify that you have the following (by simply running the command) and if not use yum install; | |
# jq | |
# sox | |
# flac | |
# dos2unix -V | |
# Ensure dos2unix is executable by the asterisk user (chmod 777 /usr/bin/dos2unix) | |
# | |
# Connect FreePBX to Google Cloud | |
# su asterisk | |
# gcloud auth login | |
# CLI will provide you a url. Copy that and paste it into your browser. Google will give you a verification code to copy. Paste it into the cli waiting for a verification code. | |
# | |
# Open FreePBX web interface | |
# Go to Settings > Voicemail Admin > Settings > Email Config | |
# Change Mail Command to: /usr/sbin/sendmail-gcloud | |
# Submit and apply changes | |
# | |
# Original source created by N. Bernaerts: https://github.com/NicolasBernaerts/debian-scripts/tree/master/asterisk | |
# modified per: https://jrklein.com/2015/08/17/asterisk-voicemail-transcription-via-ibm-bluemix-speech-to-text-api/ | |
# modified per: https://gist.github.com/lgaetz/2cd9c54fb1714e0d509f5f8215b3f5e6 | |
# current version: https://gist.github.com/tony722/7c6d86be2e74fa10a1f344a4c2b093ea | |
# | |
# Notes: This is a script modified from the original to work with FreePBX so that email notifications sent from | |
# Asterisk voicemail contain a speech to text transcription provided by Google Cloud Speech API | |
# | |
# License: There are no explicit license terms on the original script or on the blog post with modifications | |
# I'm assumig GNU/GPL2+ unless notified otherwise by copyright holder(s) | |
# | |
# Version History: | |
# 2020-08-27 Add fix by chrisduncansn | |
# Minor edit in instruction wording | |
# 2020-05-27 Add instructions from sr10952 | |
# Add export fix by levishores | |
# 2019-02-27 Initial commit by tony722 | |
# set PATH | |
PATH="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin" | |
# save the current directory | |
pushd . | |
# create a temporary directory and cd to it | |
TMPDIR=$(mktemp -d) | |
cd $TMPDIR | |
# dump the stream to a temporary file | |
cat >> stream.org | |
# get the boundary | |
BOUNDARY=$(grep "boundary=" stream.org | cut -d'"' -f 2) | |
# if mail has no boundaries, assume no attachment | |
if [ "$BOUNDARY" = "" ] | |
then | |
# send the original stream | |
mv stream.org stream.new | |
else | |
# cut the original stream into parts | |
# stream.part - header before the boundary | |
# stream.part1 - header after the bounday | |
# stream.part2 - body of the message | |
# stream.part3 - attachment in base64 (WAV file) | |
# stream.part4 - footer of the message | |
awk '/'$BOUNDARY'/{i++}{print > "stream.part"i}' stream.org | |
# cut the attachment into parts | |
# stream.part3.head - header of attachment | |
# stream.part3.wav.base64 - wav file of attachment (encoded base64) | |
sed '7,$d' stream.part3 > stream.part3.wav.head | |
sed '1,6d' stream.part3 > stream.part3.wav.base64 | |
# convert the base64 file to a wav file | |
dos2unix -o stream.part3.wav.base64 | |
base64 -di stream.part3.wav.base64 > stream.part3.wav | |
# convert the wav file to FLAC | |
sox -G stream.part3.wav --channels=1 --bits=16 --rate=8000 stream.part3.flac | |
# convert to MP3 | |
sox stream.part3.wav stream.part3-pcm.wav | |
lame -m m -b 24 stream.part3-pcm.wav stream.part3.mp3 | |
base64 stream.part3.mp3 > stream.part3.mp3.base64 | |
# create mp3 mail part | |
sed 's/x-[wW][aA][vV]/mpeg/g' stream.part3.wav.head | sed 's/.[wW][aA][vV]/.mp3/g' > stream.part3.new | |
dos2unix -o stream.part3.new | |
unix2dos -o stream.part3.mp3.base64 | |
cat stream.part3.mp3.base64 >> stream.part3.new | |
# save voicemail in tmp folder in case of trouble | |
# TMPMP3=$(mktemp -u /tmp/msg_XXXXXXXX.mp3) | |
# cp "stream.part3.mp3" "$TMPMP3" | |
export CLOUDSDK_CONFIG=/home/asterisk/.config/gcloud | |
RESULT=`gcloud ml speech recognize stream.part3.flac --language-code='en-US'` | |
FILTERED=`echo "$RESULT" | jq -r '.results[].alternatives[].transcript'` | |
# generate first part of mail body, converting it to LF only | |
mv stream.part stream.new | |
cat stream.part1 >> stream.new | |
sed '$d' < stream.part2 >> stream.new | |
# beginning of transcription section | |
echo "" >> stream.new | |
echo "--- Google transcription result ---" >> stream.new | |
# append result of transcription | |
if [ -z "$FILTERED" ] | |
then | |
echo "(Google was unable to recognize any speech in audio data.)" >> stream.new | |
else | |
echo "$FILTERED" >> stream.new | |
fi | |
# end of message body | |
tail -1 stream.part2 >> stream.new | |
# add converted attachment | |
cat stream.part3.new >> stream.new | |
# append end of mail body, converting it to LF only | |
echo "" >> stream.tmp | |
echo "" >> stream.tmp | |
cat stream.part4 >> stream.tmp | |
dos2unix -o stream.tmp | |
cat stream.tmp >> stream.new | |
fi | |
# send the mail thru sendmail | |
cat stream.new | sendmail -t | |
# go back to original directory | |
popd | |
# remove all temporary files and temporary directory | |
rm -Rf $TMPDIR |
This comment has been minimized.
This comment has been minimized.
This is code that I'm using on a production FreePBX server (just diffed it to be sure) . Keep trying, checking logs, messages, permissions, and whatever else. Hopefully you can get it. |
This comment has been minimized.
This comment has been minimized.
I forgot to post back I decided to try a stupid this morning and "reboot -h now" I left a vm after the system restarted and it transcribed properly. |
This comment has been minimized.
This comment has been minimized.
Thanks a lot for your great work. But i would love this do work with Google Speech to Text. Tried copy/paste your script but i only get: |
This comment has been minimized.
This comment has been minimized.
That's a great idea @pete1019. However I'm not running VitalPBX so I don't have a way to do this. I maintain a single FreePBX system, and just put this out there in case it helps anyone else. :-) I will say that I get this message from Google occasionally. However if you get it every time there's likely a problem. Feel free to fork this and make any changes needed. Good luck! |
This comment has been minimized.
This comment has been minimized.
I think it is just a owner / rights problem. If i run this command as root everyhing is fine and i get results. |
This comment has been minimized.
This comment has been minimized.
I've never looked at VItalPBX at all, so I don't know what user accounts it runs under. I'd suggest taking this script to the guys on the VitalPBX forums and see if they can help--I'm really unable to help at all! |
This comment has been minimized.
This comment has been minimized.
"gcloud utility must be authenticated. Before doing this, 'su asterisk' so authentication happens in the correct user account" |
This comment has been minimized.
This comment has been minimized.
I've been using this script for some time now (with FreePBX 14), and was previously using the IBM Bluemix version with no issues. However lately I've noticed that every several weeks I'll start getting the "Google was unable to recognize any speech in audio data." result. But if I pipe a raw message through the script as the |
This comment has been minimized.
This comment has been minimized.
Might be good to ask on the FreePBX forums. I've seen that kind of issue randomly, but it's always the odd message here or there and never required a reboot. I'm not even pretending to be an expert on all this. But this script worked for me so I posted it here. |
This comment has been minimized.
This comment has been minimized.
FYI, we found that the cause of the periodic failure of this script was caused by the Script attempting to get the gcloud config from /root/.config/gcloud. Seems like the parent process's HOME environment variable is used by gcloud. I added Time will tell if this keeps up. |
This comment has been minimized.
This comment has been minimized.
@levishores Makes total sense, good find! I've implemented your fix and it worked. |
This comment has been minimized.
This comment has been minimized.
Also, for posterity, you can debug the gcloud command by adding this commented line: //Insert this line to use for debugging - will dump console errors to 'error' in the tmp dir //comment this line at the bottom to keep the TMP directory for analysis after the script runs Hope this makes sense...
|
This comment has been minimized.
This comment has been minimized.
Thanks a lot for your code. I am in the process of setting it up. While setting it up I have actually tried to create a helpful user guide for, less technical people to follow along. After much troubleshooting, my FreePBX is talking to google... However, the email received is saying "Google was unable to recognize any speech in audio data." Looking through the "result" file in the log, I do see results being sent back from Google. below are two different "results" I received, from two separate voicemails. What is my next step on here?
Thinking the issue is with two levels of confidence within the result, I left another message, which was also not passed down in the email body.
|
This comment has been minimized.
This comment has been minimized.
It looks like a change Google made may have broken this script. Do you have a fix that I could incorporate here? |
This comment has been minimized.
This comment has been minimized.
Tony, I would love to be able to help you with this. |
This comment has been minimized.
This comment has been minimized.
Steps needed to get FreePBX to work with Google Cloud Speech to Text for voicemail transcriptsGoogle Account
Within FreePBX
Connect FreePBX to Google Cloud
Have FreePBX inject this code Hopefully this should do get it to work |
This comment has been minimized.
This comment has been minimized.
I have updated my comment. Github screwed with the ticks in the code, so yeah, if you just blindly copied and pasted Did you read that full comment? The concept is using it for debugging because the gcloud command doesn't execute properly when it's executed by Asterisk as part of the script. You can't see the error, but if you add an additional gcloud command and log the error text to a file, then keep the script from deleting the TMP file, you can look at the error. Root cause was that it was trying to access the gcloud config inside the root home folder, not asterisk's home. The fix was simply to add |
This comment has been minimized.
This comment has been minimized.
I have actually been able to debug it by only stopping deletion of the temp files, so I was able to see somewhat at which step it stops, although it was much more difficult to troubleshoot... I wrote this guide above that actually worked for me in production. (latest verison of FreePBX and gcloud). |
This comment has been minimized.
This comment has been minimized.
@sr10952. I've incorporated your instructions into the original gist as comments so they can be seen too. Thanks! @levishores, I've added the export line to the gist too. Thanks for your contrib. :-) |
This comment has been minimized.
This comment has been minimized.
Hi there I hope you guys can help, I tried to implement this scriot But im having issues, I dont really know whats wrong. I was also getting the template script witch i removed in order to do the testing. You are now logged in as [myemailaccount]. What else i can do to test this. Any suggestion? FYI; since i do not have a comercial license(or pay for any license) I use posfix to send SMTP emails thru google, that part works great. |
This comment has been minimized.
This comment has been minimized.
I've been using this script since late 2019 (thank you @tony722) and in recent months it's started to return Google was unable to recognize any speech in audio data. So I added the latest changes provided by @sr10952 and @levishores. Still not working. So, I debugged line by line and determined I was getting a transcription back from Google. The failure was here: if [ -z "$FILTERED" ] The extra space before the closing bracket was triggering the if statement. The odd thing is this extra space has always been in @tony722's script. Removing it fixed it though. @Acpek23 give that a try. If it doesn't work, see if Google is returning a transcription: login as the asterisk user and run RESULT= |
This comment has been minimized.
This comment has been minimized.
Thanks for updating the script @tony722! |
This comment has been minimized.
This comment has been minimized.
Thanks @chrisduncansn for finding that! |
This comment has been minimized.
This comment has been minimized.
Unfortuanaly im still unable to use this im getting nothing. I also tried to save the .mp3 on temp file to see if the conversion was success, nothing save voicemail in tmp folder in case of trouble
I also tried this: I ran: gcloud ml speech recognize stream.part3.flac --language-code='en-US' 1>result 2>error Any other suggestion? |
This comment has been minimized.
This comment has been minimized.
You're missing a space between =gcloud |
This comment has been minimized.
This comment has been minimized.
now im getting this error: ERROR: (gcloud.ml.speech.recognize) Invalid audio source [stream.part3.flac]. The source must either be a local path or a Google Cloud Storage URL (such as gs://bucket/object). Any suggestion? |
This comment has been minimized.
This comment has been minimized.
youre right and im getting this: |
This comment has been minimized.
This comment has been minimized.
//comment this line at the bottom to keep the TMP directory for analysis after the script runs run the script again, then cd in to the temp directory and re-run RESULT=gcloud ml speech recognize stream.part3.flac --language-code='en-US' |
This comment has been minimized.
This comment has been minimized.
same result [asterisk@pbx tmp.t6QQWwfhbN]$ on stream.new im able to see the "normal message" this is the one that im currently sending. Alejandro Cardenas, Hay un nuevo correo de voz en el buzón ext:
Marca *98 para acceder a su correo de voz por teléfono. |
This comment has been minimized.
This comment has been minimized.
You may wish to consider using the phone_call model. This will improve the transcription. |
This comment has been minimized.
This comment has been minimized.
Could you please be more specific? Example what to change? Thanks |
This comment has been minimized.
This comment has been minimized.
Looks like skippy1976 is referring to the speech model options available in Speech-to-Text. But I don't see an option to set a model using gcloud from the terminal. |
This comment has been minimized.
This comment has been minimized.
Looks like there's a 60 second limit for the transcriptions using "gcloud ml speech recognize". But there would be no limit to the length using "gcloud ml speech recognize-long-running". I know the length of the message is stored somewhere as that ends up in the body of the email. Anyone have any ideas on how to modify this to use an "if then" option for longer voicemails? |
This comment has been minimized.
This comment has been minimized.
I found a couple options that I like while digging into the documentation. The options I like are on the alpha channel, so there's a good chance they won't work long-term, but I'm okay with that on my setup. Here's what I changed: ORIGINAL: NEW: |
This comment has been minimized.
This comment has been minimized.
Hey guys, new to this topic... Trying to get this to work on my Asterisk box... follow all the steps as indicated. Didn't get any errors along the way, but I don't seem to get any results... The voicemail still answers, records the file... and I still get the audio file to my email.. but at the bottom I see --Google transcription result -- Also noticed that I can't play the MP3 file attached with the email.... says it's unsupported or corrupt. Did some more testing... when I leave a voicemail... and I go into the /tmp/tmp.xxxxxxx folder... I can run the command manually
and with echo $RESULT I get the transcription like so...
But still unable to get it in the email from Asterisk.... In the error file in the /tmp/tmp.xxxxxx I see this -- ERROR: (gcloud.ml.speech.recognize) Your current active account [xxxxxxxxxxx@gmail.com] does not have any valid credentials $ gcloud auth login to obtain new credentials. For service account, please activate it first: $ gcloud auth activate-service-account ACCOUNT Which is weird because the command runs manually.... Thanks! Richard |
This comment has been minimized.
This comment has been minimized.
Ok, well it turns out that this line --- export CLOUDSDK_CONFIG=/home/asterisk/.config/gcloud was a problem for my setup... Now I get the transcription.... But!!!!! the audio file is still a problem. the mp3 file doesn't work... can't listen to it.. @tony722 Any ideas ??? Anyone ??? @kevinrossen have the MP3 attachments been working for you ? |
This comment has been minimized.
This comment has been minimized.
This script fails for any voicemail longer than 1 minute, with the following error: I have fixed it by replacing with this does not "fix" the issue of too long voicemails, but it changes it so it only transcribes the first 59 seconds, which in my case is good enough. |
This comment has been minimized.
This comment has been minimized.
@kevinrossen how are those alpha options working for you? I checked and it looks like they are still in Alpha status, which is a bummer. |
This comment has been minimized.
I have been attempting to make this work for the last 4 hours and getting nowhere. I know I have google cloud set up correctly because I can change the TMPDIR to an actual location and have the system write the files there then copy the "gcloud ml speech recognize stream.part3.flac --language-code='en-US'" command and run it in that dir as the asterisk user and get the JSON however it is not running as part of the script.