extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2024-12-04 05:54:35 +01:00
Code Issues Packages Projects Releases Wiki Activity
Page: Notify_messagebird
Pages
CLI_Usage DemoPlugin_Basic DemoPlugin_WebRequest Development_API Development_Apprise_Details Development_Contribution Development_LogCapture Home Notification_Graveyard Notify_Custom_Form Notify_Custom_JSON Notify_Custom_XML Notify_Revolt Notify_africas_talking Notify_apprise_api Notify_aprs Notify_bark Notify_boxcar Notify_bulksms Notify_bulkvs Notify_burst_sms Notify_chantify Notify_clicksend Notify_d7networks Notify_dapnet Notify_dbus Notify_dingtalk Notify_discord Notify_email Fastmail Notify_email Notify_emby Notify_enigma2 Notify_faast Notify_fcm Notify_feishu Notify_flock Notify_freemobile Notify_gitter Notify_gnome Notify_googlechat Notify_gotify Notify_growl Notify_guilded Notify_homeassistant Notify_httpsms Notify_ifttt Notify_join Notify_kavenegar Notify_kodi Notify_kumulos Notify_lametric Notify_line Notify_lunasea Notify_macosx Notify_mailgun Notify_mastodon Notify_matrix Notify_mattermost Notify_messagebird Notify_misskey Notify_mqtt Notify_msg91 Notify_msteams Notify_nexmo Notify_nextcloud Notify_nextcloudtalk Notify_notica Notify_notifiarr Notify_notifico Notify_ntfy Notify_office365 Notify_onesignal Notify_opsgenie Notify_pagerduty Notify_pagertree Notify_parseplatform Notify_plivo Notify_popcornnotify Notify_prowl Notify_pushalot Notify_pushbullet Notify_pushdeer Notify_pushed Notify_pushjet Notify_pushme Notify_pushover Notify_pushsafer Notify_pushy Notify_reddit Notify_rocketchat Notify_rsyslog Notify_ryver Notify_sendgrid Notify_serverchan Notify_ses Notify_seven Notify_sfr Notify_signal Notify_simplepush Notify_sinch Notify_slack Notify_sms_manager Notify_smseagle Notify_smtp2go Notify_sns Notify_sparkpost Notify_splunk Notify_spontit Notify_streamlabs Notify_stride Notify_synology_chat Notify_syslog Notify_techulus Notify_telegram Notify_threema Notify_toasty Notify_twilio Notify_twist Notify_twitter Notify_voipms Notify_wecombot Notify_whatsapp Notify_windows Notify_workflows Notify_wxpusher Notify_wxteams Notify_xbmc Notify_xmpp Notify_zulip Sponsors Troubleshooting URLBasics config config_text config_yaml decorator_notify persistent_storage showcase
3 Notify_messagebird
Chris Caron edited this page 2020-08-03 10:06:53 -04:00
Table of Contents

MessageBird

Account Setup

To use MessageBird, you will need to acquire your API Key. This is accessible via the MessageBird Dashboard.

Syntax

Valid syntaxes are as follows:

  • msgbird://{ApiKey}/{FromPhoneNo}
  • msgbird://{ApiKey}/{FromPhoneNo}/{ToPhoneNo}
  • msgbird://{ApiKey}/{FromPhoneNo}/{ToPhoneNo1}/{ToPhoneNo2}/{ToPhoneNoN}

Parameter Breakdown

Variable Required Description
ApiKey Yes The API Key associated with your MessageBird account. This is available to you via the MessageBird Dashboard.
FromPhoneNo Yes A from phone number MUST include the country codes dialling prefix as well when placed. This field is also very friendly and supports brackets, spaces and hyphens in the event you want to format the number in an easy to read fashion. This MUST be the the number you registered with your MessageBird account.
ToPhoneNo No A to phone number MUST include the country codes dialling prefix as well when placed. This field is also very friendly and supports brackets, spaces and hyphens in the event you want to format the number in an easy to read fashion. If no ToPhoneNo is specified, then the FromPhoneNo is notified instead.

Example

Send a MessageBird Notification as an SMS:

# Assuming our {APIKey} is gank339l7jk3cjaE
# Assuming our {FromPhoneNo} - is in the US somewhere making our country code +1
#                            - identifies as 1-123-555-1223
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   msgbird://gank339l7jk3cjaE/11235551223

# the following would also have worked (spaces, brackets,
# dashes are accepted in a phone no field):
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   msgbird://gank339l7jk3cjaE/1-(123) 555-1223

Quick Links: