Incoming Message Notification

This document will go over receiving incoming message notifications via our API.

When a Mobile Originated (MO / Incoming) message is received, a notification will be POSTed to the specified webhook URL.

Headers

Header	Value
Content-Type	application/json

Arguments

Name	Type	Description
id	string	Incoming Message Id.
originator	string	The mobile number (MSISDN) which sent the message.
recipient	string	The virtual number or shortcode the message was sent to.
body	string	Message Text.
created	string	Date/Time message was received.
inReplyTo	string	ID of the message that this was in response to.
logicalMessageId	string	The Batch ID which this message is associated with.
ownerUserId	string	The ID of the user which received this message.

Examples

Payload

{
   "id":"1C9A658F0A931B317B6A53BB42EC3571",
   "originator":"4400000000",
   "recipient":"12345",
   "body":"Incoming Message",
   "created":"2023-09-01T00:30:36+0000",
   "inReplyTo":"961AEAEB0A000A9D2FBD4671D07705FE",
   "logicalMessageId":"6EE262430A931B3127AFD4F044FC0622",
   "ownerUserId":"94B8CC070A000A9D2FBD467124131CA6"
}