Home
Getting Started
Knowledge Base
Changelog
API Setup
Omnichannel API
- Overview
- Quickstart
- Theory
- Sender Name
- Specification
- Requests & Authentication
- Development Libraries
- SMS Message
- WhatsApp Message
- Viber Message
- Telegram Message
- Delivery Report
- Scheduled Messages
- Inbound Messages
- HELP
- API Reference
2FA API
- 2FA API
- API Request Authentication
- Creating Service
- Syncing Users
- Deleting users
- Starting Authentication
- PIN Code Verification
SMPP
Number Lookup
Phonebook API
Subscription API
Account Balance API
Pricing API
Statistics API EARLY ACCESS
Number Verification
SMS Messaging API DEPRECATED
- Overview
- Quickstart
- Specification
- Sending SMS
- Receiving SMS
- Delivery Report
- HTTP API Reference
Tools
FAQ
Sending more than 100 000 SMS messages a month?
Contact salesOmnichannel API
All endpoints require HTTP basic authorization header with Messente API username and password.
You can find the API username and password under your Account API Settings.
Sends an Omnimessage
POST https://api.messente.com/v1/omnimessage
Request Body
Property | Type | Info | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
torequired | string |
Phone number in e.164 format |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
messagesrequired | array |
An array of messages Viber message content
SMS message content
WhatsApp message content. Only one of "text", "image", "document" or "audio" can be provided
Telegram message content
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dlr_url | string |
URL where the delivery report will be sent Format: url
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
text_store | string |
Whether to store message content as is (plaintext), as a hashed value (sha256) or not at all (nostore) Possible values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
time_to_send | string |
Optional parameter for sending messages at some specific time in the future. Time must be specified in the ISO-8601 format. If no timezone is specified, then the timezone is assumed to be UTC Examples:
Format: date-time
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
priority | string |
Set the priority of the message. Messages are processed starting with in highest priority queue first and lowest priority queue last. This for example allows to prioritize OTP messages over marketing traffic. Possible values:
|
Successful Response
Property | Type | Info | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
messagesrequired | array |
List of messages that compose the omnimessage A message part of an omnimessage
|
||||||||||||
torequired | string |
Phone number in e.164 format |
||||||||||||
omnimessage_idrequired | string |
Unique identifier for the omnimessage Format: UUID
|
Error Responses
Property | Type | Info | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorsrequired | array |
An array of errors A container for Omnichannel API error
|
Retrieves the delivery report for the Omnimessage
GET https://api.messente.com/v1/omnimessage/{omnimessageId}/status
Request Parameters
Name | Location | Info |
---|---|---|
omnimessageIdrequired | The parameter is part of the URL path |
UUID of the omnimessage to for which the delivery report is to be retrieved
Type: string
Format: UUID
|
Successful Response
Property | Type | Info | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
statusesrequired | array |
Contains the delivery reports for each channel, ordered by send order A delivery report
|
|||||||||||||||||||||
torequired | string |
Phone number in e.164 format |
|||||||||||||||||||||
omnimessage_idrequired | string |
Unique identifier for the omnimessage Format: UUID
|
Error Responses
Property | Type | Info | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorsrequired | array |
An array of errors A container for Omnichannel API error
|
Cancels a scheduled Omnimessage
DELETE https://api.messente.com/v1/omnimessage/{omnimessageId}
Request Parameters
Name | Location | Info |
---|---|---|
omnimessageIdrequired | The parameter is part of the URL path |
UUID of the scheduled omnimessage to be cancelled
Type: string
Format: UUID
|
Successful Response
Error Responses
Property | Type | Info | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorsrequired | array |
An array of errors A container for Omnichannel API error
|
Search results
0 items foundHome
Getting Started
Knowledge Base
Changelog
API Setup
Omnichannel API
- Overview
- Quickstart
- Theory
- Sender Name
- Specification
- Requests & Authentication
- Development Libraries
- SMS Message
- WhatsApp Message
- Viber Message
- Telegram Message
- Delivery Report
- Scheduled Messages
- Inbound Messages
- HELP
- API Reference
2FA API
- 2FA API
- API Request Authentication
- Creating Service
- Syncing Users
- Deleting users
- Starting Authentication
- PIN Code Verification
SMPP
Number Lookup
Phonebook API
Subscription API
Account Balance API
Pricing API
Statistics API EARLY ACCESS
Number Verification
SMS Messaging API DEPRECATED
- Overview
- Quickstart
- Specification
- Sending SMS
- Receiving SMS
- Delivery Report
- HTTP API Reference