Skill Level: Intermediate
- Install a REST client, such as PostMan, found in the Chrome web store. IBM does not endorse a particular tool. Before using a tool, make sure that you read the terms and conditions.
- Along with Provisioning, complete the API user setup.
- You have the¬†SMS API authentication¬†username and password of the API user. To make SMS API calls, Provisioning requests a username and password on your behalf. You will receive an email notification with the username and password credentials from our SMS partner.
- Open a new Chrome browser (that is not logged into the SMS Campaign Manager).
Note:¬†This test is applicable in these situations:
- When using the¬†WebMO API to send a virtual MO to an SMS program.
- When exporting¬†SMS messages from the SMS Campaign Manager using REST API.
- When using the¬†Gateway API to send SMS messages from an external system.
Steps to test any SMS API call
Note: This example uses the Gateway API call.
- Launch Postman in Chrome.
- Click¬†Basic Auth.
- With the credentials you received via email from our SMS partner, type the username and password.
- Click¬†Refresh Headers¬†to generate the Basic Auth token.
- Construct your request URL. Here‚Äôs an example, using the Gateway API: https://communicatepro.mgage.com/api/gateway?message=Testing the API Gateway for SMS 2.0&message_billed=no&message_type=sms&numbers=17277539473
- Make sure the selection next to the¬†URL params¬†button is¬†POST.
- Paste the request URL into the¬†Enter request URL here¬†field, located above¬†Authorization. You can click¬†URL params¬†to see all of the parameters and the values passed over, based on the Request URL entered, and verify these parameters.
- Click¬†Send. You should see a 200 response.
- The SMS platform is very quick, and the message should arrive in the SMS Phone Number‚Äôs inbox within a second or two.