Jump to Content
Webex Connect API docsPlatform DocumentationPlatform ChangelogAPI ReferencePush & In-App SDKsSDK Release Notes
HomePush & In-App SDKsAPI Reference
Platform DocumentationPlatform ChangelogAPI ReferencePush & In-App SDKsSDK Release NotesFAQsWebsiteWebex Connect API docs
API Reference
FAQsWebsite
HomePush & In-App SDKsAPI Reference

GETTING STARTED

  • Overview
  • Know Your API Endpoints
  • API Authentication
  • Using JWT for API Authentication
  • Postman Collection

RATE LIMITS

  • Rate Limits for Messaging APIs, Event API, and Inbound Webhook

API Reference for Sandbox

  • Sandbox APIs Overview
  • SMS APIs & SDKs
    • Send an SMS message to a mobile devicepost
    • Retrieve the status of an SMS messageget
  • Voice APIs & SDKs
    • Place a new call, play an audio and disconnect i.e. play and droppost
    • Place a new call to a telephone numberpost
    • Retrieve the status of an individual callget
    • Retrieve information on any recordings taken during a callget
  • WhatsApp APIs & SDKs
  • SMS and Voice Support in Sandbox
  • Sandbox Rate Limits and Throughput

MULTI CHANNEL COMMUNICATION API

  • Introduction
  • SMS APIs
    • Send SMS API v1
    • Get SMS API v1
    • Send Message API v2
    • Send Message API v1
    • SMS Length and Encoding
  • Make Voice Callpost
  • Get Voice Call Statusget
  • Get Voice Call Recordingsget
  • MMS APIpost
  • Send Message v2post
  • RCS
    • RCS Capability Lookup API
    • RCS API
  • Email API
  • Push API
  • Live Chat/In-App Messaging API
  • Apple Messages for Business API
    • Apple Message for Business: Textpost
    • Apple Messages for Business: Typing Indicatorpost
    • Apple Message for Business: Text with Attachmentspost
    • Apple Message for Business: Rich Linkpost
    • Apple Message for Business: List Pickerpost
    • Apple Message for Business: Time Pickerpost
    • Apple Message for Business: Apple Pay & Authenticationpost
    • Apple Message for Business: Quick Replypost
    • Apple Message for Business: Form Messagespost
    • Apple Message for Business: iMessage Apppost
    • More Variables
  • Facebook Messenger API
  • Instagram APIpost
  • WhatsApp API
    • WhatsApp Text Messagepost
    • WhatsApp Media Messagepost
    • WhatsApp Location Messagepost
    • WhatsApp Contacts Messagespost
    • WhatsApp List Messagespost
    • WhatsApp Reply Buttonspost
    • WhatsApp Template Messagespost
    • WhatsApp HSMs-Text based proactive notification message(Deprecated)post
  • Send Message v1post
  • Get Message v2get

Voice API

  • Voice
    • Introduction
    • Place a new call, play an audio and disconnect i.e. play and droppost
    • Place a new call to a telephone numberpost
    • Retrieve the status of an individual callget
    • Retrieve information on any recordings taken during a callget

CONTACT POLICY API

  • Groups
    • Create a new consent grouppost
    • Get all consent groups belonging to a tenant.get
    • Get a consent groupget
    • Deletes a consent group and all its consumer records.delete
    • Updates an existing consent group.put
  • Consumers
    • Verify consent and increment frequency counter.post
    • Set frequency counter for consumer.put
    • Add or update consentpost
    • Get group member(s)get
    • Delete a consumer from a consent groupdelete
    • Get group membership countget
    • Add or update consent across all groups.post
    • Get all groups for consumerget
    • Get group consumer historyget
  • Notifications
    • Get notification subscriptionsget
    • Add or update a subscriptionpost
    • Deletes a subscriptiondelete
  • Contact Policy Error Codes

Status Codes

  • Channel Specific Status Codes

OUTBOUND WEBHOOKS

  • Outbound Webhooks
    • Apple Messages for Business
    • Email
    • Live Chat / In-App Messages
    • MMS
    • Messenger
    • Instagram
    • Push
    • RCS
    • SMS
    • Voice
    • WhatsApp

Data Streams

  • Data Streams
    • Data Streams - SMS
    • Data Streams - RCS
    • Data Streams - Email
    • Data Streams - Live Chat / In-App Messaging
    • Data Streams - Apple Messages for Business
    • Data Streams - Audit Logs

INBOUND WEBHOOKS

  • Inbound Webhooks

EVENT API

  • Overview
  • Custom Event v1post

Profile API v2

  • Overview
  • Create Customer Profilepost
  • Create App Profilepost
  • Get App Profile by Customer IDget
  • Get App Profile by User IDget
  • Get Customer Profileget
  • Get Profile Statusget
  • Update Customer Profileput
  • Update App Profileput
  • Delete App Profile with Customer IDdelete
  • Delete App Profile with User IDdelete
  • Delete Customer Profiledelete
  • Delete Device App Profiledelete
  • Delete Device Profile by Customer IDdelete

THREAD APIs

  • Overview
  • Create Threadpost
  • Get App Threadsget
  • Get User Threadsget
  • Get User Messagesget
  • Get User Messages v2get
  • Update Threadput
  • Get Streams - Legacyget

SEGMENT APIs

  • Overview
  • Create Segmentpost
  • List Segments in an Appget
  • Update a Segmentput
  • Delete Segmentdelete
  • Add Users to a Segmentpost
  • Get All Users of a Segmentget
  • Delete Users from a Segmentdelete

TOPIC APIs

  • Overview
  • Create a Topicpost
  • Delete a Topicdelete
  • List All Topicsget
  • Get a Topicget
  • Subscribe Users to a Topicpost
  • Get All Subscribers of a Topicget
  • Get All Topics of a Subscriberget
  • Unsubscribe multiple users from a Topicdelete
  • Unsubscribe a User from a Topicdelete
  • Unsubscribe a User from Topicsdelete

FAQs

  • API FAQs
  • Numbers FAQs
  • Channels FAQs
    • Apple Messages for Business
    • Email
    • Facebook Messenger
    • Instagram
    • Push, Live Chat & In-App Messaging FAQs
    • RCS
    • SMS
    • Voice
    • WhatsApp
  • Miscellaneous

Data Streams

Please refer the following links for the channel specific Data Streams formats:

  • SMS
  • In-App
  • RCS
  • Apple Messages for Business
  • Audit Logs

Platform

Channel Assets

Integrations

Flow Builder

API Reference

Introduction

API Endpoints

Push and In-App SDKs

Outbound Webhooks

Sandbox

Getting Started

Sandbox APIs

FAQs

Community Support

Resources

Channel FAQs

Tutorials

Tenant Best Practices

Changelog

Acceptable Usage Policy | © 2000 - 2025 Webex Connect, All Rights Reserved