![](\"https://cdn.yellowmessenger.com/KkdFyAUICvgx1656575886395.png\")
Yellow.ai's Notification API lets you send any Business-Initiated messages from the various supported channels directly from your CRM or Internal System.
\nThe API supports different channels (SMS, email, and WhatsApp) making it more easy for developers to integrate it anywhere in less time.
\nIn order to use the Notification API you have to enable it on the platform as explained here
\nNote: If Engage is not enabled, you will get a 400 error with the message API access is not enabled.
Base URL:
\nhttps://cloud.yellow.ai/api/engagements/notifications/v2/push?bot={botId}
Headers:
\n\n\nNote: Only users with Super Admin role can create a Bot API key.
\n
userDetails ObjectuserDetails may contain all relevant information about the user. It needs to have at least one contactable information and any number of additional parameters. For a WhatsApp notification, the number field is mandatory.
\"userDetails\": {\n \"number\": \"919090909090\", //mandatory for SMS, WhatsApp, Voice //country code to be added without space // if not added default 91\n \"email\": \"abc@xyz.com\", //mandatory for email channel\n \"cc\": \"cc@xyz.com\", //applicable only for email // array of string or string\n \"bcc\": \"bcc@xyz.com\", //applicable only for email // array of string or string\n }\n\nnotification Objectnotification contains the message template details that needs to be sent as a notification. templateId is mandatory.
\"notification\": {\n \"templateId\": \"template_name\", // name of the template from template manager// mandatory for WhatsApp, SMS(wherever applicable)\n \"params\": { //renderable parameters defined in the template.\n \"emiValue\": \"15000\", // variable parameter names as shown on template manager. Dynamic values can be passed.\n \"balance\": \"79999\",\n \"media\": [{ //applicable for whatsapp // \n \"title\": \"title\", //optional for document media types\n \"mediaLink\": \"https://URL.com.jpeg\",\n \"quickReplies\": [\n {\n \"type\": \"quick_reply\",\n \"value\": \"payload 1\"\n },\n {\n \"type\": \"quick_reply\",\n \"value\": \"payload 2\"\n }\n ]\n }],\n \"quickReplies\": {\n \"ctaUrlParam\": \"pricing-ai-chatbot\" // over here, \"pricing-ai-chatbot\" represents the extension of the URL after the domain (as configured in the template)\n }\n\nconfig Objectconfig contains the list of available pre-configuration that will be validated before sending the messages to the user.
\n\"config\": {\n \"customPayload\": {\n \"firstName\": \"Wasim\",\n \"phone\": \"91999999999\",\n \"UID\" : \"Got the details\"\n },\n \"postbackUrl\": \"https://webhook.url\"\n }\n\nAs soon as we receive a callback from the downstream services, we will post that data to the configured Webhook if available. Webhooks will be called with the request body.
\n{\n \"event\": {\n \"status\": \"delivered\"\n },\n \"userId\": \"919999999999\",\n \"source\": \"whatsapp\",\n \"campaign\": \"apiNotifications\",\n \"templateId\": \"video_button1\",\n \"msgId\": \"3Yp8jdIUj8jNeoFOP1ZLT\",\n \"workflowId\": null,\n \"firstName\": \"Wasim\",\n \"phone\": \"91999999999\",\n \"UID\": \"Got the details\"\n}\n\nOn successful queueing of the notification, you will receive a 202 status code with the msgId. This confirms that the message details has been received by us and will be queued for sending on the relevant channel. The downstream service will pick the queue and will start sending it and updating the delivery status on the webhook and on the reports under Data Explorer on the platform.
\nAdditionally, our outbound IPs given below must be whitelisted for the reports callback to flow into your system.
\nYou can view data regarding the campaigns you execute through the Insights module.
\nThis Collection contains few sample payload for different types of Templates supported by WhatsApp.
\nparams object should be fetched from the platform template manager only. You will see the Variable keys highlighted on the Template Content
4. ctaUrlParam should only contain the extension of the URL. The URL domain needs to be specified while creating templates. Eg: https://yellow.ai/ctaUrlParam
5. name field is only supported for media type document in media object
6. postbackUrl should contain the webhook shared by the client and needs to be added in the preference tab inside engage module.
Before starting with SMS notification API, read the article to learn more about SMS Channel and DLT Registrations.
\nPlease refer to the below doc Before you start with using V2 Notification API for Email Channel, know more about Email Outboundl.
\nBulk API lets you to send Bulk Notifications with a single API call ensuring lesser loads on your system. You can send messages to a higher volume of users. You need to create a CSV file with the information of the user and the variable parameters of the template to be used while sending the notification.
\nBulk API has two types of CSV feed support:
\nThis supports passing a CSV File hosted at client-end. A public URL needs to be passed from which the CSV will be fetched and used for the campaign.
\nname or email from WhatsApp/SMS and Email respectively.mediaLinkmediaName\n\nNote: The mediaLink and mediaName should be passed for every record in the csv. For sending same media to all the users the same media link needs to be passed for each user.
\n
\n\nMultipart/File Upload: This supports uploading a file from the local system/server directly by providing the file path.
\n
Multipart used form-data payload as described below
\nColumn name format in CSV file:
\nnumber/email: The first row should contain the user details info and the column name should be name or email from WhatsApp/SMS and Email respectively.mediaLinkmediaName\n\nNote: The mediaLink and mediaName should be passed for every record in the csv. For sending same media to all the users the same media link needs to be passed for each user.*
\n
Sample CSV :
\n\n