From e35d6fd88075c8a0571b1ba01c62512791d3bfed Mon Sep 17 00:00:00 2001 From: Robbie Trencheny Date: Sat, 14 May 2016 13:56:25 -0700 Subject: [PATCH] Add notify.twilio_sms platform docs --- source/_components/notify.twilio_sms.markdown | 54 ++++++++++++++++++ source/images/supported_brands/twilio.png | Bin 0 -> 4894 bytes 2 files changed, 54 insertions(+) create mode 100644 source/_components/notify.twilio_sms.markdown create mode 100644 source/images/supported_brands/twilio.png diff --git a/source/_components/notify.twilio_sms.markdown b/source/_components/notify.twilio_sms.markdown new file mode 100644 index 00000000000..79601056f4d --- /dev/null +++ b/source/_components/notify.twilio_sms.markdown @@ -0,0 +1,54 @@ +--- +layout: page +title: "Twilio SMS" +description: "Instructions how to add user notifications to Home Assistant." +date: 2016-01-29 +sidebar: true +comments: false +sharing: true +footer: true +logo: twilio.png +ha_category: Notifications +--- + +The Twilio notify platform enables sending notifications via SMS, powered by [Twilio](https://twilio.com). + +### Configuration + +```yaml +# Example configuration.yaml entry +notify: + platform: twilio_sms + account_sid: ACCOUNT_SID_FROM_TWILIO + auth_token: AUTH_TOKEN_FROM_TWILIO + from_number: E164_PHONE_NUMBER + # Optional + name: NOTIFIER_NAME +``` + +Configuration variables: + +- **account_sid** (*Required*): Your Twilio Account SID which can be found in your [console](https://www.twilio.com/console). It starts with the letters `AC`. +- **auth_token** (*Required*): Your Twilio Account SID which can be found in your [console](https://www.twilio.com/console). It should be directly under where you found the `account_sid`. +- **from_number** (*Required*): An [E.164](https://en.wikipedia.org/wiki/E.164) formatted phone number, like +14151234567. See [Twilio's guide to formatting phone numbers](https://www.twilio.com/help/faq/phone-numbers/how-do-i-format-phone-numbers-to-work-internationally) for more information. +- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`. + +### Usage + +Twilio is a notify platform and thus can be controlled by calling the notify service [as described here](/components/notify/). It will send a notification to all E.164 phone numbers in the notification **target**. See the notes above regarding the `from_number` configuration variable for information about formatting phone numbers. + +```yaml +# Example automation notification entry +automation: + - alias: The sun has set + trigger: + platform: sun + event: sunset + action: + service: notify.twilio_sms + data: + message: 'The sun has set' + target: + - +14151234567 + - +15105555555 +``` diff --git a/source/images/supported_brands/twilio.png b/source/images/supported_brands/twilio.png new file mode 100644 index 0000000000000000000000000000000000000000..9e9ea721e1edff99d9e5d2e2e21e73ee7edb0499 GIT binary patch literal 4894 zcmV+(6XEQMP)(00009a7bBm000XU z000XU0RWnu7ytkO8FWQhbW?9;ba!ELWdK2BZ(?O2No`?gWm08fWO;GPWjp`?601o> zK~#9!?48|_+c*+{Vb#7%30z6Od%1fWIReoU3^#(|L@?S2%!$Bq1WQF=O$19tu+-B% zU0J$IU=)Fm?QPmzt$z3ebT`26D%RNLF-Z{pp??50-hBP~)u`B)|NY}%lk&&BysDq3 z_IHq3c}-i~@>pI)?e97M+*jA%{`2p>etG-yMj^2RM1%m$QTZ2)ud_pF3Is{vQAo&v z00<(y0E#;gUi(mkCNH5Wv?mo3+ip`_17jLMvyK%o<+V{uqmXp9763-#iKVb%X*T7R zsg+Sk6buDMA?W}|f?zCE9nJ!?8oEn1NJ!9XED?^evd~Cg0GJY%Tp8lIo zB_t&vU^zah?s@5gCBDtxdj*MF549=^iCT{#$qQPQSB0cM9I&4QR;6lMH#~uKaV&kc zv1mwe-U9&9%vIR(O9{$KA!!c?q;@~5{;2z=-DB`Js+!q0Rp~v6`=0%x+L`q zkRU@#g|ACclEFfPfczS0=N?e`^BM?+t?Uh2UjQgFe^ib1rBI%Cps+y_ARs&Qqu^W4 zmCD4qr3j&k0+-4Wmt`=Jcs36* zn0itdEInMlq?t)39GydgBh}smKn4rPgwP5;B3M$4S;m4vnYrpmXOIZrZo5M`az&tVf6mb2N*(leWq;1SfdtEp zeir&MpUaP#s@nJJ+f1lcagy<}4hfDpg}{#p)+5o=o2%s9l0smhPL@+2 zU|=t81vkVebDMKpBg-F6TG|jk*v|@x8^IAfLMtsr09dOjVQZEIbL+pUdo@`1OIlq5 zYq6&lNbnHnfY#OJCiBk?3pS-d{BFxQt z9MXZ8fPbSB+v67f>`#oUYTjsjBf=~L?1`Vd>dJlQNxBLOn@BG z^>L+Gg~I?6zSrmSIhkWX5{!*p`S)<&9G_!d&_m$bwAH9hjVuY{yoi&Nju?s=ILXQ} zWQm;2PcfIky*Y0(YS4g)36QNLKw$LvOl%qNa5SD+Y)5A3)2L4_EF-#d&rFcqgnne> zCY+|Qqwmfk0LsQvJD^Xvw#q)>^If=I2M#^EHF%9~bjHl^l#O||J?~H}xyrf7Zh+W3aNGV>r*4A#?=_#hdf4b;R>TG-VPE}Eb4&$;Arw{Wn{^;ZAukg-zQ=1 zc*6IxX-&Y*{v;^|zGg{ch8MLyGNCd`JUSrd{x(wk4DU(3_aycK5?59v5vp8MwAM{y zkyvOuVh6FwD}(i)UWye*S6nS>-`9l|0arls(PnXr-;;Va$k-9UD+X(lw6P?iSdqxc zme}&|NpDA6YeJpLizGvmQZ`!BD10re;!!&y&-CJ&%Qe3V3HoJ}rv2z}#F!iTGH(!% zj6HyTV*93;>7t%DNt##^YAfP$laddo$Ib!(-Q{~`#O;WhKtgTWS7z8UF)G)r33wTl zYr5`Et>Wm6X{Q{0cY1!v%@KI!NjqG=Cv^ZHU$Z3CRwOejYH8$o8<8YPHroH+iXmK+ zB9M0U4d8b}gk&eR3{NP^6_`+Z9n*STatg^^V2$1d0Lflq|0X$?%QdP6?IF5aKDa7H z16SiHybVX!UI8X}D6?GibC!fMAAcZnwQ>)Xs|cVSd0@{uZ%K$D3Gt)4d_U<4j!j_C z5n)M4lozelHh^GMA)z1izAv>IF$L|pKt-gML(}SxxNK)Fv>j`za<2Fs%4E#^J0!NZ zUDco;Z21?Lj7I^3nYei=>tc`N!p=5hqeX4abS^VP1X!^U6lIsCwD6f z84`4BB*i9457?!ogO5yu52gM@r!h&$mINdgqF|r8p0k2Jc_IaLj&oQj4;tdMBzuk? z#SZ1(2D|H9a2l=RGjlthDUOu5=B^Sw=Z?jaa4wB!KGE+XoiZRiOa@@MlmgmjP}Kcvq8baNl<>&rXzVNxr#TE~;Gk07(_h zmlp){?~T0_@eu>-8C7r#z~i}+j}~3p16q%{z%AC4mSp~u@uwPx>wrGO?E>IZbg7sK zN(I|YGp-}5akS5{{&Ckz`e0c%!Yl`;OnwS@1n3G&jsY706X75-LD#H`-L^He4_7W} zmt_r>Nv#c0H8SD=aICp4d959<9w;uUWqb4AzyA|H9@Sae?};aaR05T90QgGusOOP> zZWWaqfxCVJ6%~aT?- z14V)fx7hrch#Q~$d-X?H*HmDeHqw+1&%UhMusHMY)gQO!$7JHh6VTO?FnoBJorVoj ziD|wn`VOy$^7^&B2Q2AWaZZ?`0;Q(i(wYTca4vgw@>nXkRx>FiBb@>NrdXg+%^(beA41-x}^$;QfbcNys6Y2m%D$s^5*<4QEf_=QliIx08#A*5jjbclapW z_aj=B$p9hwo&u(-iZ>Sm2q@OCM31|30SYQ??!bCnvnsg|P*^MpRaRy!1ds>f$Bu1+ zQUiqgbm2Q8ppZcV$qQ;oIL<*ib+I0p9zV9IV42}Ne*4bw*HNGeE*5J!R2Af3>~ zx(3RoXFF2UZO5TaxySe5=*J16N3yL$@)|lMM$YjCi>}!s1pR}Mc6@M^kdPMFa##{_ zcMC_osgWaTN4INbWC_RnQ0h<41<9NkkZLAfl8oEF6UK52VeMEj#F&)&v;PhW@tUJC zv6)VcfUMdXS+=w$sgWt^ARws+DFK?yrBLMpa2ply#-$+(q3u{uEnUIqkh#s(lC3%< z!NnzLv8G0@Bn^KrHnJrSNpDaNr-6H@!FwcJxfTkE*#0cIA)$&(q(jnla&-|1?7qNw z9ukJ#b_u~Vd??{MZ{RW-4`81=zJFwB6EOKXOF|vIQ;Z5z5A#g~dE`+x@1 z{F)`9j!ULk(PPL`Fe;yTm~mA?EDaLs)v`l}L~CE&)(^_8*7kIn*60>R1oGf;S;N)? zB`A9Sy9jaUs#7m3`iqemooOs|3iVOa36lbfhXhBpgYY&uc|Q!;@5DjE+??VHY} zD_6q;aMIfmiWNEAAD1A>h+l5(=z~aCu8rm2lirRtRs>w|dkO6rT`=)MxLoL}tOYAq z*03GWc}JmbI6A5yoJ#4Bk)Y9Q>ZrItCRDk$E!WGfgto)_d!ZGfu4=Qp)E^^Z%4Iz^ z!K{nKELYk=8Kqg1qa%1Z284_HKDwe@K-G@;MP0=v(sn0q+onv>bre?!!uHm0%xH0x zOxm=Dgpuf_?RgUf{#nrIn{;eP$}n(Ub5C5j#~iW9%e5@yr~zHnCVuP!PC*K`?0N1- zEWqtL8V4&Su)-$C2D7W7#i)Ua=SV-^J1SKZF)P@*{H9q?*!PBi^>kwUfFF!SIXsuc zt?XQrqZhdR;LJe~|H=po0Fqd02XyKqQ@=bqO8I7nr}WcJ{T?;w5b)J=|c=n9L%>Ud~l}X&s;=+=mmmy;)&2$MCXalsR%~JCnTGh;TeP}EKk{iA{&2O6y0Bs@R zBp>7*r4nLC!Zo|_E6~Y%!RMVtul?RAQ50qju@Ya zRZ5jcIs}6YXI09#ZFH#15!DG}l^VSv!H)uN*9RdVrCPD7pzr_!uJ418 z*MV9BQQwWq=amr9JBk~gqyCf8#f$N;Gp zE8Yuwt);EyOV%ujKwq?yPp&pSsW{z_(?_gst*{D-K%cZ8r^LE2(z<)K64=+)H|dQW zyyVizsSQ;LtoJH#?T|`;Kp+?{1Oj4kFtnPqv2ICDeAKbPk4UzyHc;!4me-TeS9DUS z!U-fbU-h%lkNK^Jt)mKrAzKenz^TwzbT*mn3=;gXpoAX;_x%B_O0F1O?86ztu@L;4 zP;%AT5!p^55gf>$bHP%D#Vgm!S)k4V$pqt*I}dcjd4&*9;ILIWhQe)*Tu&N1hr~lr zKwdCr$p-|-48ce|fP)MWGDvEjPDxYX#fEH<1Psb)EK}h1ifuKf zM@doqW)%<x1gaU`1RZ4{?wnD2b7`4Oqp!h%5;u5|Ua#pAR@- z9h#7wWEK=88m9~@{)iDA*s1v z0Ls1Un70DitHh_pp|^l_FCnQ}75Ly!s(W6<9!p>M;&=#n&vzP^fe4V*(FOaR;n1NNf926ucz$6HZ zE}pzCRT-shhzGU~7LpTJEK%!n(Q0HvFC;#ANKSy6BP{WNfq6kNHmVT{NmF1V6ZUL= zWid7ihCyle1HjDi zf7-BX`A@L8MswAmFcq*yNl(vz&6{t$5zN*XQR{k%*0K*?0ztQ*S Q4gdfE07*qoM6N<$f{_H`KmY&$ literal 0 HcmV?d00001