Platform DocumentationPlatform ChangelogAPI ReferencePush & In-App SDKsSDK Release Notes
API Reference
FAQsWebsite

Sandbox APIs Overview

Webex Connect Sandbox is a pre-configured environment in which you can prototype applications with channels such as SMS, voice and WhatsApp. It is designed to allow enterprise developers to try the APIs, SDKs and our advanced CPaaS capabilities such as flow builder, debugging tools and analytics.

❗️

New Sandbox Site

Webex Connect Sandbox will now be available at sandbox.us.webexconnect.io. Your existing Sandbox account, which is currently accessible at sandbox.imiconnect.io, will be decommissioned on 30th September 2024. The new date will be reflected in your Sandbox accounts by 30th August 2024.

Action Required:

Please create a new account on sandbox.us.webexconnect.io and ensure that you migrate your flows, templates, webhooks and any other configurations to your new sandbox account before the decommission date.

For more information on limitations and FAQs, please refer to this link.

Here's a brief overview of the APIs that are available within Webex Connect sandbox:

📘

API Availability Differences between Sandbox Mode and Full Platform Mode

  • Please note that communication API access in Sandbox is limited to SMS and Voice in the new Sandbox Site.
  • WhatsApp APIs support is not available on the new Sandbox site, this will be introduced in a subsequent release. However, this support is already present in the old Sandbox site.
  • The endpoint for each of the channels are separate, and some of these APIs are available only in Sandbox mode at the moment.
  • Custom Event API and Inbound Webhooks are available in Sandbox mode.
  • Other APIs such as Profile API, Thread APIs, Segment APIs, and Topic APIs are not available in the Sandbox mode.

API Endpoints for Sandbox


Sandbox API TypeAPI CapabilityOld Sandbox EndpointNew Sandbox Endpoint
SMS API
Send an SMS messagehttps://api-sandbox.imiconnect.io/v1/sms/messageshttps://api.us.webexconnect.io/v1/sms/messages
Retrieve the status of a send SMS message requesthttps://api-sandbox.imiconnect.io/v1/sms/messages/{messageId}https://api.us.webexconnect.io/v1/sms/messages/{messageId}
Voice
Place a new call, play an audio and disconnect i.e. play and drophttps://api-sandbox.imiconnect.io/v1/voice/messageshttps://api.us.webexconnect.io/v1/voice/messages
Place a new call to a telephone numberhttps://api-sandbox.imiconnect.io/v1/voice/callshttps://api.us.webexconnect.io/v1/voice/calls
Retrieve the status of an individual callhttps://api-sandbox.imiconnect.io/v1/voice/calls/{sessionId}https://api.us.webexconnect.io/v1/voice/calls/{sessionId}
Retrieve information on any recordings taken during a callhttps://api-sandbox.imiconnect.io/v1/voice/calls/{sessionId}/recordingshttps://api.us.webexconnect.io/v1/voice/calls/{sessionId}/recordings
WhatsApp
Send a WhatsApp messagehttps://api-sandbox.imiconnect.io/v1/whatsapp/messagesCurrently not supported in New Sandbox Site
Retrieve the status of a WhatsApp messagehttps://api-sandbox.imiconnect.io/v1/whatsapp/messages/{messageId}Currently not supported in New Sandbox Site
Custom EventInvoking or resuming an Webex Connect flow by making an API call with a fixed pre-configured payload of key-value pairs.Refer DocumentationRefer Documentation
Inbound WebhooksInvoking or resuming an Webex Connect flow by making an API call with a flexible JSON/XML payload.Refer DocumentationRefer Documentation

Signing Up for Webex Connect Sandbox

If you're an enterprise developer who wants to explore Webex Connect APIs, SDKs, and capabilities before subscribing to the enterprise platform license can sign-up for a sandbox account here.