Text Notifications Report API

Purpose: The purpose of this API is to fetch a list of text notification details associated with a center.

Response Details

NameTypeDescription
NotificationsObjectObject containing the name of the centers using the email notifications.
page_infoObjectObject containing the pagination details.
totalintDenotes the number of pages in the response.
pageintDenotes the current page of the response.
sizeintDenotes the size of the page.

Notifications Object

NameTypeDescription
center_namestringName of the center which uses the email notifications.
guest_codestringCode of the guest to whom the email is sent.
guest_namestringName of the guest to whom the email is sent.
message_type_namestringType of notification sent to the guest.
messagestringThis is the message sent to the guest.
statusstringStatus of the email sent to the guest.
reasonstringThis is the reason for sending the message.
sent_ondate timeDate and time when the message was sent to the guest.
sent_tostringThe phone number to which the text message is sent.
guest_mobilestringThe phone number of the guest.
credits_consumedintDenotes the number of text message credits consumed for sending the text message to guest.

error Object

MessageCodeDescription
notification template ids are missing502This error occurs when the notification template ids are not mentioned.
center ids are missing502This error occurs when the center_id parameter is missing.
start_date must be earlier than end_date502This error occurs when an invalid start_date is mentioned.
invalid start_date or end_date502This error occurs when an invalid start_date or end_date is mentioned.
Language
Authorization
Header
Click Try It! to start a request and see the response here!