Sandbox APIs Overview

The Webex Connect developer 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.

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, Voice, and WhatsApp APIs.
  • 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 Type

API Capability

Endpoint

SMS API

Send an SMS message

https://developers.imiconnect.io/reference#post_v1-sms-messages

Retrieve the status of a send SMS message request

https://developers.imiconnect.io/reference#get_v1-sms-messages-messageid

Voice

Place a new call, play an audio and disconnect i.e. play and drop

https://developers.imiconnect.io/reference#post_v1-voice-messages

Place a new call to a telephone number

https://developers.imiconnect.io/reference#post_v1-voice-calls

Retrieve the status of an individual call

https://developers.imiconnect.io/reference#get_v1-voice-calls-sessionid

Retrieve information on any recordings taken during a call

https://developers.imiconnect.io/reference#get_v1-voice-calls-sessionid-recordings

WhatsApp

Send a WhatsApp message

https://developers.imiconnect.io/reference#post_v1-whatsapp-messages

Retrieve the status of a WhatsApp message

https://developers.imiconnect.io/reference#get_v1-whatsapp-messages-messageid

Custom Event

Invoking or resuming an Webex Connect flow by making an API call with a fixed pre-configured payload of key-value pairs.

https://developers.imiconnect.io/reference#external-event

Inbound Webhooks

Invoking or resuming an Webex Connect flow by making an API call with a flexible JSON/XML payload.

https://developers.imiconnect.io/reference#custom-event-v2

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.