Text Message | Send Message: POST https://chatapps.8x8.com/api/v1/subaccounts/{subAccountId}/messages Sends a plain text message to the user. View JSON{ "user": { "msisdn": "+15551234567" }, "type": "text", "content": { "text": "Welcome to 8x8 Inc.! We are the leading global provider of unified cloud communications, video collaboration, and contact center solutions.\n\nWe empower your business to thrive in the modern workplace by offering a single, secure, and integrated platform for all your voice, video, chat, and customer service needs.\n\nOur solutions are designed to deliver exceptional experiences for both your employees and your customers, ensuring seamless global connectivity and robust reliability.\n\nHow can we help you unify your communications today? Reply with INFO for a quick link to our solutions guide or TALK to connect with a specialist." } }
|
Image Message | Send Message: POST https://chatapps.8x8.com/api/v1/subaccounts/{subAccountId}/messages Sends an image from a URL with optional text caption. View JSON{ "user": { "msisdn": "+15551234567" }, "type": "Image", "content": { "url": "https://chatapps.8x8.com/files/7723febafb67440b89c6872e9d72efdd.jpeg?token=CfDJ8LwbBIzqYzxMo4VXraj4E8kbpPbOLHNZ3GfGzhGDm3ajqPMrbjJONU3UAtPsnv00QjW7FYXfmj5QMjTz9hbcVRMnhy-jJWfHshe83bNAzbZjJwkaf-31Ok2UXF7C6fyAOPTKVPOnUU3ERQcgvkE7GC-NZf9vJnt7_cDoHKjawoPyxrodvh7LRtIqVKR-TDysUg", "text": "Welcome to the world of 8x8 ChatApps APIs!\nCommunications for the customer obsessed." } }
|
Video Message | Send Message: POST https://chatapps.8x8.com/api/v1/subaccounts/{subAccountId}/messages Sends a video from a URL with optional text caption. View JSON{ "user": { "msisdn": "+15551234567" }, "type": "video", "content": { "url": "https://samplelib.com/lib/preview/mp4/sample-5s.mp4", "text": "This is the video file" } }
|
Document Message | Send Message: POST https://chatapps.8x8.com/api/v1/subaccounts/{subAccountId}/messages Sends a document from a URL with optional filename and caption. View JSON{ "user": { "msisdn": "+15551234567" }, "type": "File", "content": { "url": "https://pdfobject.com/pdf/sample.pdf", "text": "Thanks for your interest. Attached is our latest 8x8 brochure with all the details you need. Take a look and let me know if you have any questions!" } }
|
Location Message | Send Message: POST https://chatapps.8x8.com/api/v1/subaccounts/{subAccountId}/messages Sends a location message with latitude, longitude, name, and address. View JSON{ "user": { "msisdn": "+15551234567" }, "type": "location", "content": { "location": { "latitude": "1.2857", "longitude": "103.8479", "name": "8x8 Singapore Office", "address": "1 George St, #22-03/04 One George Street, Singapore 049145" } } }
|
 | Send Message: POST https://chatapps.8x8.com/api/v1/subaccounts/{subAccountId}/messages Creates a list menu with multiple options organized in sections. View JSON{ "user": { "msisdn": "+15551234567" }, "type": "interactive", "content": { "interactive": { "type": "list", "header": { "type": "text", "text": "8x8 Customer Success personalized sessions" }, "body": { "text": "Looking for personalized assistance? Our Customer Success team has the following slots available. Tap to select a time." }, "footer": { "text": "For urgent inquiries, email cpaas-sales@8×8.com" }, "action": { "button": "Book Slot", "sections": [ { "title": "Oct 9, 2024", "rows": [ { "id": "slot-1", "title": "Monday, Oct 9", "description": "9:00 AM - 10:00 AM" }, { "id": "slot-2", "title": "Monday, Oct 9", "description": "11:00 AM - 12:00 PM" } ] }, { "title": "Oct 10, 2024", "rows": [ { "id": "slot-3", "title": "Tuesday, Oct 10", "description": "2:00 PM - 3:00 PM" }, { "id": "slot-4", "title": "Tuesday, Oct 10", "description": "4:00 PM - 5:00 PM" } ] } ] } } } }
|
 | Send Message: POST https://chatapps.8x8.com/api/v1/subaccounts/{subAccountId}/messages Creates an interactive message with up to 3 reply buttons. Users can tap a button to send a quick reply. View JSON{ "user": { "msisdn": "+15551234567" }, "type": "interactive", "content": { "interactive": { "type": "button", "header": { "type": "text", "text": "8x8" }, "body": { "text": "👋 Welcome to 8x8 Inc.! We are the leading provider of cloud communications, video collaboration, and contact center solutions.\n\nTo help you quickly find what you need, please select one of the options below:\n\n📞 Contact Us: Speak directly with a Sales or Support representative regarding your account or new service inquiry.\n\n❓ FAQ: Get instant answers to common questions about our products, pricing, and features.\n\n📍 Office: Find the address and contact details for our global office locations." }, "footer": { "text": "This is an official message from 8x8." }, "action": { "buttons": [ { "type": "reply", "reply": { "title": "contact-us", "id": "option-1" } }, { "type": "reply", "reply": { "title": "faq", "id": "option-2" } }, { "type": "reply", "reply": { "title": "office", "id": "option-3" } } ] } } } }
|
 | Send Message: POST https://chatapps.8x8.com/api/v1/subaccounts/{subAccountId}/messages Creates an interactive message with an image header and up to 3 reply buttons. View JSON{ "user": { "msisdn": "+15551234567" }, "type": "interactive", "content": { "interactive": { "type": "cta_url", "header": { "type": "image", "image": { "link": "https://chatapps.8x8.com/files/991c9667f7644584acf91aa8dd9fba60.png?token=CfDJ8LwbBIzqYzxMo4VXraj4E8k4uW4Kjsnx2rTsG0O-bgz0v3CXHYwHi8BVTm1jLn6tSswTva_BhILXyvFi2DmZZQOcYmEn60cOdB2mvtEEBvd3lEA6f1P1kL2K8TpWIOaTcca70UdUtOZTnmNfdHBrJugXjasrG4Zu7WW5JOEbPF4kDOynKUulYQdVqRIR-DU9lw" } }, "body": { "text": "Welcome to 8x8 Inc. How may we help?" }, "footer": { "text": "This is an official message from 8x8." }, "action": { "parameters": { "display_text": "Click for more", "url": "https://developers.facebook.com/docs/whatsapp/cloud-api/messages/interactive-cta-url-messages" } } } } }
|
 | Send Message: POST https://chatapps.8x8.com/api/v1/subaccounts/{subAccountId}/messages Creates a message with a single CTA button that can open a URL or initiate a phone call. View JSON{ "user": { "msisdn": "+15551234567" }, "type": "interactive", "content": { "interactive": { "type": "cta_url", "header": { "type": "text", "text": "8x8" }, "body": { "text": "Welcome to 8x8! We are the leading provider of cloud communications, video collaboration, and contact center solutions.\n\n" }, "footer": { "text": "This is an official message from 8x8." }, "action": { "parameters": { "display_text": "Click for more", "url": "https://developers.facebook.com/docs/whatsapp/cloud-api/messages/interactive-cta-url-messages" } } } } }
|
Interactive Flow | Send Message: POST https://chatapps.8x8.com/api/v1/subaccounts/{subAccountId}/messages Sends an interactive message that opens a WhatsApp Flow when tapped. Flows enable structured data collection through guided forms within WhatsApp. Can only be sent within the 24-hour customer service window. View JSON{ "user": { "msisdn": "+15551234567" }, "type": "Interactive", "content": { "interactive": { "type": "flow", "header": { "type": "image", "image": { "link": "https://iili.io/KtDO5BV.jpg" } }, "body": { "text": "Hello! Ready to transform your customer engagement? Schedule a demo with our 8x8 sales team to explore our SMS, Voice, and Video APIs." }, "footer": { "text": "Empowering global communications." }, "action": { "parameters": { "flowId": "1633450807827276", "flowCta": "Schedule now" } } } } }
Note: The Flow must be published before sending. Use the Flow Configuration API to create and publish Flows. See WhatsApp Flows for complete documentation.
|
Product Message (Single) | Send Message: POST https://chatapps.8x8.com/api/v1/subaccounts/{subAccountId}/messages Displays a single product from your WhatsApp Business catalog. View JSON{ "user": { "msisdn": "+15551234567" }, "type": "interactive", "content": { "interactive": { "type": "product", "body": { "text": "Check out this amazing product from our store!" }, "footer": { "text": "Limited stock available" }, "action": { "catalog_id": "YOUR_CATALOG_ID", "product_retailer_id": "PRODUCT_SKU_123" } } } }
|
Product List Message | Send Message: POST https://chatapps.8x8.com/api/v1/subaccounts/{subAccountId}/messages Displays multiple products from your WhatsApp Business catalog in sections. View JSON{ "user": { "msisdn": "+15551234567" }, "type": "interactive", "content": { "interactive": { "type": "product_list", "header": { "type": "text", "text": "Featured Products" }, "body": { "text": "Browse our latest collection of products." }, "footer": { "text": "Free shipping on orders over $50" }, "action": { "catalog_id": "YOUR_CATALOG_ID", "sections": [ { "title": "Best Sellers", "product_items": [ { "product_retailer_id": "PRODUCT_SKU_1" }, { "product_retailer_id": "PRODUCT_SKU_2" } ] }, { "title": "New Arrivals", "product_items": [ { "product_retailer_id": "PRODUCT_SKU_3" }, { "product_retailer_id": "PRODUCT_SKU_4" } ] } ] } } } }
|