Channels API Documentation

This is the complete API documentation for connecting to the Channels API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Channels: Channels is a business phone system and call center platform for managing users, contacts, phone numbers, calls, recordings, finance data, reports, and related phone operations through the Channels REST API. Keep reading to get started.

Quickstart

Before you run your first Channels request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Channels connection — create or choose one in Connections. Note its connectionId.

Every Channels action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/channels/latest/actions/{actionSlug}

You need a MindCloud API Key and a Channels connection. Then call an action such as Check User Exists:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/channels/latest/actions/check-user-exists" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Channels account that should run the action. MindCloud stores and refreshes the Channels credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

Channels actions

All 30 published actions for this Channels version. Each page documents the endpoint, arguments, and response controls.

• POSTAdd Contact Alternative MSISDN
• POSTAdd Contact Note
• PUTAdd Or Update Contact Details
• POSTBlock MSISDN
• GETCheck User Exists
• POSTCreate Public Recording Link
• POSTCreate Recordings Archive Link
• DELETEDelete Contact
• DELETEDelete Contact Alternative MSISDN
• DELETEDelete Public Recording Link
• PUTDisable User
• PUTEdit Contact Details
• PUTEnable User
• GETGet Call
• GETGet Contact
• GETGet Contact Details
• GETGet Contact History
• GETGet Number Do Not Call History
• GETGet User Stats
• POSTImport Contact
• GETList Calls
• GETList Contact Alternative MSISDNs
• GETList Contacts
• GETList Do Not Call History
• GETList Phone Numbers
• GETList Public Recording Links
• GETList Users
• PUTSet Inbound Call Forwarding
• DELETEUnblock MSISDN
• PUTUpdate Contact

Related apps

More Support apps on the Universal API, behind the same REST shape. Or browse all apps.

TrelloClickUpZendeskQuoIntercomEventbriteTickTickLinear