Using a tool capable of making POST requests such as Postman, send a POST request to the /sendMessage endpoint with a json body containing the to and text fields. The to field should be an array of E.164 formatted phone numbers to send the SMS to.
{
"to": ["+19195551234"],
"text": "Hello World!"
}The example above will text the number +19195551234 a picture of a cat and the words Hello World!.
The other two endpoints are used for handling inbound and outbound webhooks from Bandwidth. In order to use the correct endpoints, you must check the "Use multiple callback URLs" box on the application page in Dashboard. Then in Dashboard, set the INBOUND CALLBACK to /callbacks/inbound/messaging and the STATUS CALLBACK to /callbacks/outbound/messaging/status. The same can be accomplished via the Dashboard API by setting InboundCallbackUrl and OutboundCallbackUrl respectively.
Inbound callbacks are sent notifying you of a received message on a Bandwidth number, this app saves any inbound images to the working directory. Outbound callbacks are status updates for messages sent from a Bandwidth number, this app has a dedicated response for each type of status update.
In order to use the Bandwidth API users need to set up the appropriate application at the Bandwidth Dashboard and create API tokens.
To create an application log into the Bandwidth Dashboard and navigate to the Applications tab. Fill out the New Application form selecting the service (Messaging or Voice) that the application will be used for. All Bandwidth services require publicly accessible Callback URLs, for more information on how to set one up see Callback URLs.
For more information about API credentials see our Account Credentials page.
To install the required packages for this app, run the command:
bundle installUse the following command to run the application:
ruby app.rbThe sample app uses the below environmental variables.
BW_ACCOUNT_ID # Your Bandwidth Account Id
BW_USERNAME # Your Bandwidth API Username
BW_PASSWORD # Your Bandwidth API Password
BW_NUMBER # The Bandwidth phone number involved with this application
BW_MESSAGING_APPLICATION_ID # Your Messaging Application Id created in the dashboard
LOCAL_PORT # The port number you wish to run the sample onFor a detailed introduction, check out our Bandwidth Messaging Callbacks page.
Below are the callback paths:
/callbacks/outbound/messaging/statusFor Outbound Status Callbacks/callbacks/inbound/messagingFor Inbound Message Callbacks
A simple way to set up a local callback URL for testing is to use the free tool ngrok.
After you have downloaded and installed ngrok run the following command to open a public tunnel to your port ($LOCAL_PORT)
ngrok http $LOCAL_PORTYou can view your public URL at http://127.0.0.1:4040 after ngrok is running. You can also view the status of the tunnel and requests/responses here.