Welcome to the Webex Interact API documentation. This API empowers developers to seamlessly integrate and automate customer interactions within their applications. Whether you're looking to send personalised SMS messages, manage your contact lists, or receive real-time event notifications, the Webex Interact API provides the tools you need to enhance your communication strategies.
Our API is designed for developers building customer engagement platforms, marketing automation tools, notification services, and more, offering robust and flexible access to Webex Interact's core functionalities.
Key Capabilities
The Webex Interact API allows you to:
- Send SMS Messages: Programmatically send individual or bulk SMS messages, including support for personalisation and scheduling.
- Manage Contacts: Create, update, and retrieve contact information and lists.
- Configure Senders: Manage your sender IDs for outgoing communications.
- Check account information: Includes your latest monetary credit balance.
- Handle Webhooks: Subscribe to and receive real-time notifications for various events, such as SMS delivery reports.
Getting Started
Authentication
All requests to the Webex Interact API require authentication. You will need an API key to authorise your requests. Please refer to our Authentication Guide for instructions on how to obtain and use your API key.
Base URL
The base URL for all API requests is: https://api.webexinteract.com/v1
Important Concepts
Data Format: All requests and responses are typically handled in JSON format. Ensure your requests include the Content-Type: application/json header for POST/PUT requests.
HTTP Methods: We adhere to standard RESTful conventions, utilising HTTP methods like GET (retrieve data), POST (create data), PUT (update data), and DELETE (remove data).
Error Handling: The API uses standard HTTP status codes to indicate the success or failure of a request. Detailed error information, including specific error codes and messages, can be found in our Error Codes section.
Rate Limiting: To ensure service stability and fair usage, rate limits are enforced per endpoint. If you exceed these limits, you will receive a 429 Too Many Requests HTTP status code. Please consult the respective API function documentation page for the specific limits.