Before you get started, please contact your account manager to ensure that your account has access to this product and that the following points have been managed:
- You will need a new sub-account id to use this API endpoint - it can’t be an existing SMS SubAccount.
- In order to use your existing channels such as WhatsApp, Viber, Zalo, Line, etc, we will have to configure them for you.
- The fallback mechanism has to be set up by the 8x8 team. You have to define which channels you want to use (and in which order) and the time between each channel is triggered.
Downloading Messaging APIs (OAS File)
You can download the OAS File - Click Here
Please Right-click on the link and choose Save Link AsPlease do take note that the file provides all the Messaging APIs so please look through the .OAS file and select the specific Messaging API(s) required.
Fallback mechanism on WhatsApp
WhatsApp ensures message delivery for up to 30 days, even if recipients are offline. To avoid duplicate messages for both WhatsApp and SMS, we highly recommend you extend the fallback duration. Please contact your account manager or our support team to help optimize your fallback duration.
Once this is done, you can use Messaging API. The API key is available in the Customer Portal.
Authentication
- 8x8 Messaging API accepts an ApiKey Bearer Token authentication method.
- You can generate tokens from your customer portal https://connect.8x8.com/
- You need to include the following header in your requests:
Authorization: Bearer {apiKey}
Replace the
{apiKey}placeholder with the key generated from the customer portal.
If you haven't created your account yet, please go to 8x8 website https://connect.8x8.com to sign up.
URL
The 8x8 subAccountId to use is defined in the URL where you send your request as shown below:
https://chatapps.8x8.com/api/v1/subaccounts/{subAccountId}/messages
You must replace
{subAccountId}in the URL above with the sub-account id that you want to use.