To start using the Webex Interact APIs for SMS messaging, you’ll need to generate a secure Access token by navigating to Developers>Create API project page.
🗝️ Webex Interact API uses Access token to authenticate requests. You must create and include it in the Header( “X-AUTH-KEY”) parameter in your requests. Without this, all requests will fail.
You can generate multiple tokens, to access our Messaging API based on your requirements.
Here’s a step-by-step guide to help you through the process.
Name: Choose a name that defines the purpose and objective of your API project (e.g., “Customer Notifications” or “Promotional Campaigns”) to help you manage and identify different projects.
Scope: Select the capabilities for your API project by setting permissions for specific channels.
Currently, permissions are available for the SMS channel. In the future, you can set permissions individually for each channel, enabling you to manage access for different messaging channels as needed.IP address: Specify the IP addresses or ranges to ensure that only requests from trusted sources are allowed. This ensures that only authorized IPs can interact with your API project.
A single IP address (e.g.,
123.123.1.1)An IP range (e.g.,
196.168.1/255)Or both
🚧 If the access token is not recognized or invalid, you will receive an error message to help you troubleshoot the issue and successfully authenticate your request.
Access token generation
Once your API project setup is complete, an access token will be generated for that project. Use this token to authenticate each HTTP request when you interact with the Webex Interact API for sending SMS messages.
With your access token ready, you can start using the Webex Interact API. Remember to include it in the header of each HTTP request for secure interactions. For instructions on sending SMS campaigns, check the API documentation.