This page is a quick way to understand how Simpu works. Simpu datamodels consists of SMS, Email, OTP, Lookup and Airtime.

​
SMS

Boost growth with effective SMS campaigns. Stay connected with your customers at every stage of their journey by sending post-transaction, promotional, and personalized SMS messages.
​
id
string
required
Unique Id of the sms message
​
recipients
array
required
Recipients of the SMS message
​
sender_id
string
required
The Sender ID of the SMS message
​
is_trackable
boolean
This determines if links in the message should be tracked
​
content
string
The content of the SMS message
​
external_ref
string
This is a reference to the message in your system
​
callback
string
This is the URL to receive delivery reports for the message
​
template_id
string
Template ID of the SMS message
​
personalisation
Object
​
created_datetime
string
Date and time the SMS was created
​
updated_datetime
string
Date and time the SMS token was last updated, if any.
​
meta
Object
required

​
Email

Launch email campaigns that captivate your audience. Engage customers at the ideal moment with tailored messages. Increase your revenue by pinpointing and targeting the right customers.
​
id
string
required
Unique ID of the email
​
recipients
array
required
Recipients of the Email
​
sender_id
string
required
The Sender ID of the Email
​
external_ref
string
This is a reference to the email in your system
​
callback
string
This is the URL to receive delivery reports for the message
​
template_id
string
Template ID of the Email message
​
from_name
string
The sender of the email
​
personalisation
Object
​
created_datetime
string
Date and time the SMS was created
​
updated_datetime
string
Date and time the SMS token was last updated, if any.
​
meta
Object
required

​
LookupPhone

To look up a phone number on the system
​
msisdn
string
required
The phone number looked up
​
operator
string
The carrier of the phone number
​
country
string
The country of the phone number
​
ported
boolean
The ported status of the phone number
​
dnd
boolean
The DND status of the phone number

​
OTP Model

OTP (One-Time Password) Model is designed to manage the generation, validation, and lifecycle of one-time passwords used for secure authentication.
​
id
string
required
Unique ID of the OTP token
​
recipient
string
required
Recipient of the OTP token
​
status
number
required
Status of the OTP token. Possible values are:
1 - 5
​
status_desc
string
required
Description of the status of the OTP token. Possible values are:
SENT EXPIRED FAILED VERIFIED DELETED
​
created_datetime
string
required
Date and time the OTP token was created
​
updated_datetime
string
Date and time the OTP token was last updated, if any

​
Airtime

This typically explains the structure and parameters involved in managing airtime transactions within a system.
​
id
string
required
Unique ID of the airtime
​
recipient
string
required
Recipient of the Airtime
​
amount
number
required
Amount of the Airtime
​
external_ref
string
This is a reference to the airtime in your system
​
callback
string
This is the URL to receive delivery reports for the message
​
status
string
Status of the Airtime. Possible values are:
pending sent failed error success duplicate
​
created_datetime
string
Date and time the Airtime was created
​
network
string
The network carrier of the airtime. Possible values are:
Airtel MTN Glo 9mobile NTEL
​
meta
Object
required