Communication
The Communications module manages user notifications to keep users informed and engaged through personalized push notifications. Use it to enable users to view notifications they've opted into, modify their communication preferences, and update push tokens for real-time updates.
Manage communication consents for individuals or entities within system or application. Retrieve existing communication consents (such as consent for email marketing or SMS notifications) and update them as needed.
Operations
GET
# Retrieves communication consent status.
POST
# Updates or inserts consent settings.
GET
# Retrieves communication consent status.
POST
# Updates or inserts consent settings.
Get the consent provided by the user for receiving communication.
Parameters
No Parameters
Response
200
Success. Returns all available communication opt-ins along with the consent details. Check the example shown below or refer `CommunicationConsent` for more details.
CommunicationConsent
app_id
string
The ID of the sales channel where the user has given their consent.
user_id
string
Identifier which can uniquely identify the user.
channels
object (CommunicationConsentChannels)
CommunicationConsentChannels
email
object (CommunicationConsentChannelsEmail)
CommunicationConsentChannelsEmail
response
string
The user's choice to opt in or opt out of receiving communications.
display_name
string
Name of the channel of communication the user has agreed to receive messages through.
sms
object (CommunicationConsentChannelsSms)
CommunicationConsentChannelsSms
response
string
The user's choice to opt in or opt out of receiving communications.
display_name
string
Name of the channel of communication the user has agreed to receive messages through.
whatsapp
object (CommunicationConsentChannelsWhatsapp)
CommunicationConsentChannelsWhatsapp
response
string
The user's choice to opt in or opt out of receiving communications.
display_name
string
Name of the channel of communication the user has agreed to receive messages through.
country_code
string
Alphanumeric identification code for the users country.
phone_number
string
Phone number of the user that the user has accepted to receive communication through WhatsApp.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Update or insert the consent provided by the user for receiving communication messages.
Parameters
No Parameters
Request body
response
string
Whether the user has responded to the inquiry regarding their preference for opting in or out of receiving communications.
Enum
action
string
The user's choice to opt in or opt out of receiving communications.
Enum
channel
string
The channel of communication the user has agreed to receive messages through.
Enum
Response
200
Success. Updates the channels for which user has consented. Check the example shown below or refer `CommunicationConsentRes` for more details.
CommunicationConsentRes
app_id
string
The ID of the sales channel where the user has given their consent.
user_id
string
Identifier which can uniquely identify the user.
channels
object (CommunicationConsentChannels)
CommunicationConsentChannels
email
object (CommunicationConsentChannelsEmail)
CommunicationConsentChannelsEmail
response
string
The user's choice to opt in or opt out of receiving communications.
display_name
string
Name of the channel of communication the user has agreed to receive messages through.
sms
object (CommunicationConsentChannelsSms)
CommunicationConsentChannelsSms
response
string
The user's choice to opt in or opt out of receiving communications.
display_name
string
Name of the channel of communication the user has agreed to receive messages through.
whatsapp
object (CommunicationConsentChannelsWhatsapp)
CommunicationConsentChannelsWhatsapp
response
string
The user's choice to opt in or opt out of receiving communications.
display_name
string
Name of the channel of communication the user has agreed to receive messages through.
country_code
string
Alphanumeric identification code for the users country.
phone_number
string
Phone number of the user that the user has accepted to receive communication through WhatsApp.
Examples
Parameters
body:
body
Was this section helpful?
POST
Response
Retrieve the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp. .
Parameters
No Parameters
Response
200
Success. Returns all available communication opt-ins along with the consent details. Check the example shown below or refer `CommunicationConsent` for more details.
CommunicationConsent
app_id
string
The ID of the sales channel where the user has given their consent.
user_id
string
Identifier which can uniquely identify the user.
channels
object (CommunicationConsentChannels)
CommunicationConsentChannels
email
object (CommunicationConsentChannelsEmail)
CommunicationConsentChannelsEmail
response
string
The user's choice to opt in or opt out of receiving communications.
display_name
string
Name of the channel of communication the user has agreed to receive messages through.
sms
object (CommunicationConsentChannelsSms)
CommunicationConsentChannelsSms
response
string
The user's choice to opt in or opt out of receiving communications.
display_name
string
Name of the channel of communication the user has agreed to receive messages through.
whatsapp
object (CommunicationConsentChannelsWhatsapp)
CommunicationConsentChannelsWhatsapp
response
string
The user's choice to opt in or opt out of receiving communications.
display_name
string
Name of the channel of communication the user has agreed to receive messages through.
country_code
string
Alphanumeric identification code for the users country.
phone_number
string
Phone number of the user that the user has accepted to receive communication through WhatsApp.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Update and insert the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp. .
Parameters
No Parameters
Request body
response
string
Whether the user has responded to the inquiry regarding their preference for opting in or out of receiving communications.
Enum
action
string
The user's choice to opt in or opt out of receiving communications.
Enum
channel
string
The channel of communication the user has agreed to receive messages through.
Enum
Response
200
Success. Updates the channels for which user has consented. Check the example shown below or refer `CommunicationConsentRes` for more details.
CommunicationConsentRes
app_id
string
The ID of the sales channel where the user has given their consent.
user_id
string
Identifier which can uniquely identify the user.
channels
object (CommunicationConsentChannels)
CommunicationConsentChannels
email
object (CommunicationConsentChannelsEmail)
CommunicationConsentChannelsEmail
response
string
The user's choice to opt in or opt out of receiving communications.
display_name
string
Name of the channel of communication the user has agreed to receive messages through.
sms
object (CommunicationConsentChannelsSms)
CommunicationConsentChannelsSms
response
string
The user's choice to opt in or opt out of receiving communications.
display_name
string
Name of the channel of communication the user has agreed to receive messages through.
whatsapp
object (CommunicationConsentChannelsWhatsapp)
CommunicationConsentChannelsWhatsapp
response
string
The user's choice to opt in or opt out of receiving communications.
display_name
string
Name of the channel of communication the user has agreed to receive messages through.
country_code
string
Alphanumeric identification code for the users country.
phone_number
string
Phone number of the user that the user has accepted to receive communication through WhatsApp.
Examples
Parameters
body:
body
Was this section helpful?
POST
Response
One time passwords(OTP) are an easy an secure way to authenticate customers. OTP is a secret codeword which is randomly generated and sent to customer over email or SMS communication. The customer in response shares this code back and authenticates themselves. Using this resource you can make use of OTP engine which is responsible for generating a OTP plus sending it to a customer and verifying the OTP sent by the customer. There are multiple option available with using this service like what template is to be send or which messaging provider is to be selected as well as some other advanced options available in OTP Configuration Management. By using OTP Configuration Manager you can set the way in which otp should be generated. you can choose with options like numric only otp or alphanumeric otp and the lenght of the otp. Availabe otp configuration are : options: - Length (4,6,8) - Type (Numeric/Alpha Numeric) - Expiry time etc.
Operations
GET
# Get otp-configuration, if not present in db then return default settings
Parameters
No Parameters
Response
200
Success
OtpConfiguration
otp_length
integer
Enum
type
string
Enum
expiry
object (OtpConfigurationExpiry)
OtpConfigurationExpiry
duration
object (OtpConfigurationExpiryDuration)
OtpConfigurationExpiryDuration
time
number
denomination
string
Enum
type
string
Enum
rate_limit
object (OtpConfigurationRateLimit)
OtpConfigurationRateLimit
duration
number
limit
integer
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response