Jump to Content

Platform Documentation Platform Changelog API Reference Push & In-App SDKs SDK Release Notes

Home Push & In-App SDKs API Reference Discussions

Platform Documentation Platform Changelog API Reference Push & In-App SDKs SDK Release Notes FAQs Website

Home Push & In-App SDKs API Reference Discussions

GETTING STARTED

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

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
WhatsApp APIs & SDKs
- Send a WhatsApp message to a mobile devicepost
- Retrieve the status of a WhatsApp messageget
SMS and Voice Support in Sandbox
Sandbox Rate Limits and Throughput

Voice API

Introduction
Place a new call, play an audio and disconnect i.e. play and droppost
Place a new call to a telephone number (Handle via Events and Actions after Answered)post
Retrieve the status of an individual callget
Retrieve information on any recordings taken during a callget

SMS API

Introduction
Send SMS v1post
Get SMS v1get

MULTI CHANNEL COMMUNICATION API

Introduction
Send Message v1post
Send Message v2post
Get Message v2get
MMS APIpost
Make Callpost
Get Call Statusget
Get Recordingsget
Instagram APIpost
Google Business Messages APIpost
Apple Messages for Business
WhatsApp

Channel Specific Status Codes

Channel Specific Status Codes

OUTBOUND WEBHOOKS

Outbound Webhooks

Data Streams

Data Streams
- Data Streams - SMS
- Data Streams - RCS

INBOUND WEBHOOKS

Inbound Webhooks

EVENT API

Overview
Custom Event v1post

RATE LIMITS

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

RCS Capability API

Capability APIpost

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
Get Streams - Legacyget
Get App Threadsget
Create Threadpost
Get User Threadsget
Get User Messagesget
Get User Messages v2get
Update Threadput

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
Miscellaneous

Contact Policy API

Groups
Consumers
Notifications

GETTING STARTED

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

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
WhatsApp APIs & SDKs
- Send a WhatsApp message to a mobile devicepost
- Retrieve the status of a WhatsApp messageget
SMS and Voice Support in Sandbox
Sandbox Rate Limits and Throughput

Voice API

Introduction
Place a new call, play an audio and disconnect i.e. play and droppost
Place a new call to a telephone number (Handle via Events and Actions after Answered)post
Retrieve the status of an individual callget
Retrieve information on any recordings taken during a callget

SMS API

Introduction
Send SMS v1post
Get SMS v1get

MULTI CHANNEL COMMUNICATION API

Introduction
Send Message v1post
Send Message v2post
Get Message v2get
MMS APIpost
Make Callpost
Get Call Statusget
Get Recordingsget
Instagram APIpost
Google Business Messages APIpost
Apple Messages for Business
WhatsApp

Channel Specific Status Codes

Channel Specific Status Codes

OUTBOUND WEBHOOKS

Outbound Webhooks

Data Streams

Data Streams
- Data Streams - SMS
- Data Streams - RCS

INBOUND WEBHOOKS

Inbound Webhooks

EVENT API

Overview
Custom Event v1post

RATE LIMITS

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

RCS Capability API

Capability APIpost

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
Get Streams - Legacyget
Get App Threadsget
Create Threadpost
Get User Threadsget
Get User Messagesget
Get User Messages v2get
Update Threadput

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
Miscellaneous

Contact Policy API

Groups
Consumers
Notifications

Send an SMS message to a mobile device

post https://api-sandbox.imiconnect.io/v1/sms/messages

Callback

Language

Authorization

Bearer

Click Try It! to start a request and see the response here!