# Route Mobile Project Documentation > Documentation for Route Mobile Project ## Guides - [WhatsApp](https://developer.rmlconnect.net/route-mobile-project/docs/whatsapp.md) - [WhatsApp User Guide](https://developer.rmlconnect.net/route-mobile-project/docs/whatsapp-user-guide.md) - [Overview](https://developer.rmlconnect.net/route-mobile-project/docs/wbm-kh-overview.md) - [Getting Started on the Route Mobile Panel](https://developer.rmlconnect.net/route-mobile-project/docs/wbm-kh-getting-started-on-the-route-mobile-panel.md) - [Best Practices & Content Policies](https://developer.rmlconnect.net/route-mobile-project/docs/wbm-kh-best-practices-and-content-policies.md) - [Send Direct Messaging](https://developer.rmlconnect.net/route-mobile-project/docs/send-direct-messaging-1.md) - [Sample Content Category Check](https://developer.rmlconnect.net/route-mobile-project/docs/sample-content-category-check-1.md) - [Overview](https://developer.rmlconnect.net/route-mobile-project/docs/overview.md) - [Common Request Fields](https://developer.rmlconnect.net/route-mobile-project/docs/common-request-fields-1.md) - [Send Direct Text Messages](https://developer.rmlconnect.net/route-mobile-project/docs/send-direct-text-messages-1.md) - [Interactive CTA Message](https://developer.rmlconnect.net/route-mobile-project/docs/interactive-cta-message-1.md) - [Interactive Reply Button Message](https://developer.rmlconnect.net/route-mobile-project/docs/interactive-reply-button-message-1.md) - [Unsupported Message Types (Send Direct)](https://developer.rmlconnect.net/route-mobile-project/docs/unsupported-message-types-send-direct.md) - [Fetch Auto-Generated Templates](https://developer.rmlconnect.net/route-mobile-project/docs/fetch-auto-generated-templates-1.md) - [Direct Send Message Callbacks](https://developer.rmlconnect.net/route-mobile-project/docs/direct-send-message-callbacks-1.md) - [Field Constraints Quick Reference](https://developer.rmlconnect.net/route-mobile-project/docs/field-constraints-quick-reference-1.md) - [HTTP Response Codes](https://developer.rmlconnect.net/route-mobile-project/docs/http-response-codes-1.md) - [WhatsApp Payments API](https://developer.rmlconnect.net/route-mobile-project/docs/whatsapp-payments-api.md) - [Onboarding API](https://developer.rmlconnect.net/route-mobile-project/docs/onboarding-api-1.md) - [Acculync URL Shortening](https://developer.rmlconnect.net/route-mobile-project/docs/acculync-url-shortening-1.md): Create branded Acculync short URLs, use them in WhatsApp templates and CTA buttons, and track campaign clicks. - [Government Use Cases Request Manual](https://developer.rmlconnect.net/route-mobile-project/docs/government-use-cases-request-manual.md): Prepare and submit a compliant WhatsApp Business Platform government use case request as an authorized Solution Partner. - [MM Lite Marketing API](https://developer.rmlconnect.net/route-mobile-project/docs/mm-lite-marketing-api-1.md): Send optimized WhatsApp marketing messages with Marketing Messages Lite, accept the required Terms of Service, and onboard business customers. - [WBP White Label Solution](https://developer.rmlconnect.net/route-mobile-project/docs/wbp-white-label-solution.md): Choose an RML subdomain or custom domain and prepare the assets, credentials, certificates, and contacts required for a WBP white-label solution. - [Meta Graph API Onboarding Guide](https://developer.rmlconnect.net/route-mobile-project/docs/meta-graph-api-onboarding-guide.md): Onboarding Guide - [Dynamic Pricing API Documentation](https://developer.rmlconnect.net/route-mobile-project/docs/dynamic-pricing-api-documentation.md) - [API Overview](https://developer.rmlconnect.net/route-mobile-project/docs/whatsapp-api.md) - [WhatsApp Login](https://developer.rmlconnect.net/route-mobile-project/docs/whatsapp-login.md) - [WhatsApp Management APIs](https://developer.rmlconnect.net/route-mobile-project/docs/whatsapp-management-apis.md) - [WhatsApp Bulk Upload](https://developer.rmlconnect.net/route-mobile-project/docs/whatsapp-bulk-upload.md) - [WhatsApp Catalog Manager](https://developer.rmlconnect.net/route-mobile-project/docs/whatsapp-catalog-manager.md) - [WhatsApp Reports](https://developer.rmlconnect.net/route-mobile-project/docs/whatsapp-reports.md) - [WhatsApp Optin API](https://developer.rmlconnect.net/route-mobile-project/docs/whatsapp-optin-api.md) - [View Template Message](https://developer.rmlconnect.net/route-mobile-project/docs/view-template-message.md) - [Create Template](https://developer.rmlconnect.net/route-mobile-project/docs/whatsapp-create-template.md) - [Send Template and Session Messages API](https://developer.rmlconnect.net/route-mobile-project/docs/send-template-and-session-messages-api.md): Send WhatsApp template messages and session messages with dropdown sections for supported message types and API responses. - [Generate Media ID API](https://developer.rmlconnect.net/route-mobile-project/docs/generate-media-id-api.md) - [Edit Template](https://developer.rmlconnect.net/route-mobile-project/docs/edit-template.md) - [Delete Template](https://developer.rmlconnect.net/route-mobile-project/docs/delete-template.md) - [WhatsApp Client Callback API](https://developer.rmlconnect.net/route-mobile-project/docs/whatsapp-client-callback-api.md) - [CTA Button in Session Message](https://developer.rmlconnect.net/route-mobile-project/docs/cta-button-in-session-message.md) - [Voice APIs](https://developer.rmlconnect.net/route-mobile-project/docs/voice-apis.md) - [Send message Voice APIs](https://developer.rmlconnect.net/route-mobile-project/docs/send-message-voice-apis.md) - [Template management Voice APIs](https://developer.rmlconnect.net/route-mobile-project/docs/template-management-voice-apis.md) - [CRM Integrations](https://developer.rmlconnect.net/route-mobile-project/docs/crm-integrations.md) - [MoEngage × Route Mobile WhatsApp](https://developer.rmlconnect.net/route-mobile-project/docs/moengage-route-mobile-whatsapp.md) - [CleverTap × Route Mobile WhatsApp](https://developer.rmlconnect.net/route-mobile-project/docs/clevertap-route-mobile-whatsapp.md) - [RCS](https://developer.rmlconnect.net/route-mobile-project/docs/rcs.md) - [RCS User Guide](https://developer.rmlconnect.net/route-mobile-project/docs/rcs-user-guide.md) - [Overview](https://developer.rmlconnect.net/route-mobile-project/docs/rcs-kh-overview.md) - [RCS Agent Categories](https://developer.rmlconnect.net/route-mobile-project/docs/rcs-agent-categories.md) - [Types of RCS Business Messages](https://developer.rmlconnect.net/route-mobile-project/docs/rcs-message-types.md) - [Getting Started on the Route Mobile Panel](https://developer.rmlconnect.net/route-mobile-project/docs/getting-started-on-route-mobile-panel.md) - [How to create Template](https://developer.rmlconnect.net/route-mobile-project/docs/rcs-create-template.md) - [How to send a RCS Business Message](https://developer.rmlconnect.net/route-mobile-project/docs/rcs-send-messages.md) - [RBM Dashboard](https://developer.rmlconnect.net/route-mobile-project/docs/rbm-dashboard.md) - [RBM Campaign Manager](https://developer.rmlconnect.net/route-mobile-project/docs/rbm-campaign-manager.md) - [RBM Opt-In Dashboard](https://developer.rmlconnect.net/route-mobile-project/docs/rbm-opt-in-dashboard.md) - [RBM Reporting](https://developer.rmlconnect.net/route-mobile-project/docs/rbm-reporting.md) - [Bulk Capability Check](https://developer.rmlconnect.net/route-mobile-project/docs/bulk-capability-check.md) - [Contact Group](https://developer.rmlconnect.net/route-mobile-project/docs/contact-group.md) - [Best Practices & Content Policies](https://developer.rmlconnect.net/route-mobile-project/docs/best-practices-and-content-policies.md) - [RCS API Overview](https://developer.rmlconnect.net/route-mobile-project/docs/rcs-api.md) - [Introduction about RCS](https://developer.rmlconnect.net/route-mobile-project/docs/introduction-about-rcs.md) - [Authentication API](https://developer.rmlconnect.net/route-mobile-project/docs/rcs-authentication-api.md) - [Capability Check API](https://developer.rmlconnect.net/route-mobile-project/docs/capability-check-api.md) - [RCS Send Message API](https://developer.rmlconnect.net/route-mobile-project/docs/rcs-send-message-api.md) - [Create Template API documentation](https://developer.rmlconnect.net/route-mobile-project/docs/create-template-api.md) - [Send Template Message API](https://developer.rmlconnect.net/route-mobile-project/docs/send-template-message-api.md) - [Fallback to SMS](https://developer.rmlconnect.net/route-mobile-project/docs/fallback-to-sms.md) - [Fallback to WhatsApp](https://developer.rmlconnect.net/route-mobile-project/docs/fallback-to-whatsapp.md) - [Callback Structure](https://developer.rmlconnect.net/route-mobile-project/docs/callback-structure.md) - [File Server API (Media ID)](https://developer.rmlconnect.net/route-mobile-project/docs/file-server-api-media-id.md) - [Make a Tester](https://developer.rmlconnect.net/route-mobile-project/docs/make-a-tester.md) - [Bulk Upload Campaign](https://developer.rmlconnect.net/route-mobile-project/docs/bulk-upload-campaign.md) - [Open URL with Webview](https://developer.rmlconnect.net/route-mobile-project/docs/open-url-with-webview.md) - [Viber](https://developer.rmlconnect.net/route-mobile-project/docs/viber.md) - [Viber API Overview](https://developer.rmlconnect.net/route-mobile-project/docs/viber-api.md) - [Introduction about Viber](https://developer.rmlconnect.net/route-mobile-project/docs/introduction-about-viber.md) - [Authentication API](https://developer.rmlconnect.net/route-mobile-project/docs/viber-authentication-api.md) - [Viber Template API (OTP / Transactional)](https://developer.rmlconnect.net/route-mobile-project/docs/viber-template-api-otp-transactional.md) - [Viber Single Message API](https://developer.rmlconnect.net/route-mobile-project/docs/viber-single-message-api.md) - [Viber Bulk Message API](https://developer.rmlconnect.net/route-mobile-project/docs/viber-bulk-message-api.md) - [Email](https://developer.rmlconnect.net/route-mobile-project/docs/email.md) - [Overview](https://developer.rmlconnect.net/route-mobile-project/docs/email-overview.md) - [Authentication & Authorization](https://developer.rmlconnect.net/route-mobile-project/docs/email-authentication.md) - [Base URLs & Endpoints](https://developer.rmlconnect.net/route-mobile-project/docs/base-urls-and-endpoints.md) - [Request & Response Format](https://developer.rmlconnect.net/route-mobile-project/docs/request-and-response-format.md) - [Rate Limits & Quotas](https://developer.rmlconnect.net/route-mobile-project/docs/rate-limits-and-quotas.md) - [Single API (v1.0)](https://developer.rmlconnect.net/route-mobile-project/docs/single-api.md) - [Email API SMTP User](https://developer.rmlconnect.net/route-mobile-project/docs/email-api-smtp-user.md) - [Send Email](https://developer.rmlconnect.net/route-mobile-project/docs/message-calls.md) - [Sending Domains](https://developer.rmlconnect.net/route-mobile-project/docs/sending-domain-calls.md): Add, list, verify, check, and delete sending domains with Single API v1.0. - [Suppression Management](https://developer.rmlconnect.net/route-mobile-project/docs/suppression-apis.md): Add, check, and remove email addresses from the suppression list with Single API v1.0. - [Tracking Domains](https://developer.rmlconnect.net/route-mobile-project/docs/tracking-domain-calls.md): Add, list, check, and delete branded email tracking domains with Single API v1.0. - [Webhooks](https://developer.rmlconnect.net/route-mobile-project/docs/webhook-calls.md): Create, update, list, inspect, reset, and delete email event webhooks with Single API v1.0. - [Account API](https://developer.rmlconnect.net/route-mobile-project/docs/account-calls.md): Retrieve SendClean account details, sending limits, reputation information, and account status with Single API v1.0. - [Bulk API (v2.0)](https://developer.rmlconnect.net/route-mobile-project/docs/bulk-api.md) - [Mail Send CallBack](https://developer.rmlconnect.net/route-mobile-project/docs/mail-send-callback.md) - [SMTP CallBack](https://developer.rmlconnect.net/route-mobile-project/docs/smtp-callback.md) - [Sending Defaults CallBack](https://developer.rmlconnect.net/route-mobile-project/docs/sending-defaults-callback.md) - [Sending Domain CallBack](https://developer.rmlconnect.net/route-mobile-project/docs/sending-domain-callback.md) - [Smtp Token CallBacks](https://developer.rmlconnect.net/route-mobile-project/docs/smtp-token-callbacks.md) - [Tracking Domain CallBack](https://developer.rmlconnect.net/route-mobile-project/docs/tracking-domain-callback.md) - [Webhook CallBack](https://developer.rmlconnect.net/route-mobile-project/docs/webhook-callback.md) - [Appendix](https://developer.rmlconnect.net/route-mobile-project/docs/appendix.md) - [SendClean Email API](https://developer.rmlconnect.net/route-mobile-project/docs/sendclean-email-api.md) - [Accounts](https://developer.rmlconnect.net/route-mobile-project/docs/accounts.md) - [Domain Verification](https://developer.rmlconnect.net/route-mobile-project/docs/domain-verification.md) - [Messages](https://developer.rmlconnect.net/route-mobile-project/docs/messages.md) - [Sending Domains](https://developer.rmlconnect.net/route-mobile-project/docs/sending-domains.md) - [SMTP Users](https://developer.rmlconnect.net/route-mobile-project/docs/smtp-users.md) - [Tracking Domains](https://developer.rmlconnect.net/route-mobile-project/docs/tracking-domains.md) - [Webhooks](https://developer.rmlconnect.net/route-mobile-project/docs/webhooks.md) - [Create Your SendClean Account](https://developer.rmlconnect.net/route-mobile-project/docs/sendclean-create-your-sendclean-account.md) - [A/B Testing](https://developer.rmlconnect.net/route-mobile-project/docs/a-b-testing.md) - [Automation](https://developer.rmlconnect.net/route-mobile-project/docs/automation.md) - [Create and Manage Contact List](https://developer.rmlconnect.net/route-mobile-project/docs/create-and-manage-contact-list.md) - [Design an Email](https://developer.rmlconnect.net/route-mobile-project/docs/design-an-email.md) - [Domain Verification](https://developer.rmlconnect.net/route-mobile-project/docs/domain-verification.md) - [Email Marketing Deck](https://developer.rmlconnect.net/route-mobile-project/docs/email-marketing-deck.md) - [Segmentation](https://developer.rmlconnect.net/route-mobile-project/docs/segmentation.md) - [Set Up a Campaign](https://developer.rmlconnect.net/route-mobile-project/docs/set-up-a-campaign.md) - [SMS](https://developer.rmlconnect.net/route-mobile-project/docs/sms.md) - [SMS API Overview](https://developer.rmlconnect.net/route-mobile-project/docs/api-documentation.md) - [SMPP Gateway Manual](https://developer.rmlconnect.net/route-mobile-project/docs/routemobile-smpp-gateway-manual.md): Statement of confidentiality for the RouteMobile SMPP Gateway Manual. - [SMPP Gateway Manual Page](https://developer.rmlconnect.net/route-mobile-project/docs/smpp-gateway-manual-page.md) - [Submitting Messages](https://developer.rmlconnect.net/route-mobile-project/docs/submitting-messages.md) - [Delivery Reports](https://developer.rmlconnect.net/route-mobile-project/docs/delivery-reports.md) - [SOAP Access Service](https://developer.rmlconnect.net/route-mobile-project/docs/soap-access-service.md) - [DLR Push API](https://developer.rmlconnect.net/route-mobile-project/docs/dlr-push-api.md) - [Acculync](https://developer.rmlconnect.net/route-mobile-project/docs/acculync.md) - [SMS User Guides](https://developer.rmlconnect.net/route-mobile-project/docs/sms-user-guides.md): Manage SMS messaging workflows from one place. - [SmsPlus SGN Client ](https://developer.rmlconnect.net/route-mobile-project/docs/smsplus-sgn-client-user-guide.md): User Guide - [Introduction](https://developer.rmlconnect.net/route-mobile-project/docs/introduction.md) - [Common Function](https://developer.rmlconnect.net/route-mobile-project/docs/common-function.md) - [Send an SMS](https://developer.rmlconnect.net/route-mobile-project/docs/send-an-sms.md): Send Single SMS, Bulk SMS, and Group SMS messages from SmsPlus SGN Client. - [Manage Campaigns](https://developer.rmlconnect.net/route-mobile-project/docs/manage-campaigns.md): Create, upload, and update campaigns in SmsPlus SGN Client. - [Additional Functions](https://developer.rmlconnect.net/route-mobile-project/docs/additional-functions.md) - [Manage Jobs](https://developer.rmlconnect.net/route-mobile-project/docs/manage-jobs.md) - [Other Messaging Interface](https://developer.rmlconnect.net/route-mobile-project/docs/other-messaging-interface.md) - [View Pricing Details](https://developer.rmlconnect.net/route-mobile-project/docs/view-pricing-details.md): View and download operator-wise coverage and pricing details in SmsPlus SGN Client. - [Reports](https://developer.rmlconnect.net/route-mobile-project/docs/reports.md) - [International Distributor Distadmin ](https://developer.rmlconnect.net/route-mobile-project/docs/international-distributor-distadmin-administrator-guide.md): Administrator Guide - [Introduction](https://developer.rmlconnect.net/route-mobile-project/docs/introduction-1.md): Understand the Administrator Guide structure and the purpose of International Distributor Distadmin. - [Know the User Interface](https://developer.rmlconnect.net/route-mobile-project/docs/know-the-user-interface.md): Sign in to Distadmin, reset your password, understand interface elements, and change your system password. - [Administer Users](https://developer.rmlconnect.net/route-mobile-project/docs/administer-users.md): Create and manage Distadmin users, resellers, default signup resources, alerts, and module notifications. - [Manage User and Reseller Routing](https://developer.rmlconnect.net/route-mobile-project/docs/manage-user-and-reseller-routing.md) - [RSms ](https://developer.rmlconnect.net/route-mobile-project/docs/rsms-user-guide.md): User Guide - [Introduction](https://developer.rmlconnect.net/route-mobile-project/docs/rsms-introduction.md) - [Common Functions](https://developer.rmlconnect.net/route-mobile-project/docs/rsms-common-functions.md) - [Send an SMS](https://developer.rmlconnect.net/route-mobile-project/docs/rsms-send-an-sms.md) - [Manage Jobs](https://developer.rmlconnect.net/route-mobile-project/docs/rsms-manage-jobs.md): Find, review, edit, stop, delete, and download SMS jobs in Job Management. - [Additional Functions](https://developer.rmlconnect.net/route-mobile-project/docs/rsms-additional-functions.md): Use RSms website navigation to view products and pricing, access FAQs, add account credit, and register a trial account. - [Reports](https://developer.rmlconnect.net/route-mobile-project/docs/rsms-reports.md): Review SMS delivery, credit usage, daily statistics, summary reports, and integrated product analytics in RSms. - [Appendix](https://developer.rmlconnect.net/route-mobile-project/docs/rsms-appendix-job-statuses-and-actions.md): Job Statuses and Actions - [International Reseller Webadmin ](https://developer.rmlconnect.net/route-mobile-project/docs/international-reseller-webadmin.md): Administrator Guide - [Introduction](https://developer.rmlconnect.net/route-mobile-project/docs/international-reseller-webadmin-introduction.md): Learn about International Reseller Webadmin, its administrator and support user roles, core features, and the structure of this administrator guide. - [Know the User Interface](https://developer.rmlconnect.net/route-mobile-project/docs/international-reseller-webadmin-know-the-user-interface.md) - [Administer Users](https://developer.rmlconnect.net/route-mobile-project/docs/international-reseller-webadmin-administer-users.md): Create and manage International Reseller Webadmin users, support users, notifications, and support-user permissions. - [Manage User Routing](https://developer.rmlconnect.net/route-mobile-project/docs/international-reseller-webadmin-manage-user-routing.md): Assign, price, edit, report on, and review message routes for users in International Reseller Webadmin. - [Manage User Activities](https://developer.rmlconnect.net/route-mobile-project/docs/international-reseller-webadmin-manage-user-activities.md): Find, review, stop, restart, and delete user message jobs in International Reseller Webadmin. - [Personalise Portals](https://developer.rmlconnect.net/route-mobile-project/docs/international-reseller-webadmin-personalise-portals.md): Personalise the International Reseller Webadmin client portal website and messaging interface with manual controls, themes, templates, taglines, and signatures. - [Recharge your Account](https://developer.rmlconnect.net/route-mobile-project/docs/international-reseller-webadmin-recharge-your-account.md): Make online payments and review credit balances, overdrafts, and credit transactions in International Reseller Webadmin. - [Other Reports](https://developer.rmlconnect.net/route-mobile-project/docs/international-reseller-webadmin-other-reports.md): Review message activity, delivery statistics, credit usage, routing details, and verification reports in International Reseller Webadmin. - [Appendix](https://developer.rmlconnect.net/route-mobile-project/docs/appendix-2.md): Reference job statuses and available job actions in International Reseller Webadmin. - [NewWebsms](https://developer.rmlconnect.net/route-mobile-project/docs/newwebsms.md): User Guide - [Introduction](https://developer.rmlconnect.net/route-mobile-project/docs/newwebsms-chapter-1-introduction.md): Learn NewWebsms features, sign in to the portal, manage your profile and password, and contact the help desk. - [Common Functions](https://developer.rmlconnect.net/route-mobile-project/docs/newwebsms-chapter-2-common-functions.md): Select NewWebsms message types, schedule SMS messages, add Acculync links, and remove duplicate recipients. - [Send an SMS](https://developer.rmlconnect.net/route-mobile-project/docs/newwebsms-chapter-3-send-an-sms.md): Send Single, Bulk, Personalised Bulk, and Group SMS messages and manage scheduled jobs in NewWebsms. - [Additional Functions](https://developer.rmlconnect.net/route-mobile-project/docs/newwebsms-chapter-4-additional-functions.md): View NewWebsms product information and pricing, access FAQs, and register a trial account online. - [Reports](https://developer.rmlconnect.net/route-mobile-project/docs/newwebsms-chapter-5-reports.md): Review NewWebsms delivery, credit usage, daily statistics, summary reports, and Acculync analytics. - [Appendix A: Job Statuses](https://developer.rmlconnect.net/route-mobile-project/docs/newwebsms-appendix-a-job-statuses.md): Reference NewWebsms job statuses during file processing and message submission. - [Introduction](https://developer.rmlconnect.net/route-mobile-project/docs/uae-panel-introduction.md) - [Login](https://developer.rmlconnect.net/route-mobile-project/docs/uae-panel-login.md) - [Dashboard](https://developer.rmlconnect.net/route-mobile-project/docs/uae-panel-dashboard.md) - [Send SMS](https://developer.rmlconnect.net/route-mobile-project/docs/uae-panel-send-sms.md) - [Job Management](https://developer.rmlconnect.net/route-mobile-project/docs/uae-panel-job-management.md) - [Address Book](https://developer.rmlconnect.net/route-mobile-project/docs/uae-panel-address-book.md) - [Reports](https://developer.rmlconnect.net/route-mobile-project/docs/uae-panel-reports.md) - [User Profile](https://developer.rmlconnect.net/route-mobile-project/docs/uae-panel-user-profile.md) - [OCEAN](https://developer.rmlconnect.net/route-mobile-project/docs/ocean.md) - [OCEAN User Guide](https://developer.rmlconnect.net/route-mobile-project/docs/ocean-user-guide.md) - [Home & Dashboard](https://developer.rmlconnect.net/route-mobile-project/docs/ocean-home-and-dashboard.md) - [Campaigns](https://developer.rmlconnect.net/route-mobile-project/docs/ocean-campaigns.md) - [Channel Reports](https://developer.rmlconnect.net/route-mobile-project/docs/ocean-channel-reports.md) - [Templates](https://developer.rmlconnect.net/route-mobile-project/docs/ocean-templates.md) - [Drive](https://developer.rmlconnect.net/route-mobile-project/docs/ocean-drive.md) - [Journeys](https://developer.rmlconnect.net/route-mobile-project/docs/ocean-journeys.md) ## API Reference - [Send SMS (Secured)](https://developer.rmlconnect.net/route-mobile-project/reference/sendsmssecured.md): Submits a single SMS or a batch of SMS messages for delivery over HTTPS. Available on both port 443 and port 8443. **Long messages:** Messages exceeding standard length are automatically split and reassembled on the recipient device. Billing is per segment: - Plain text: 153 characters per segment - Unicode: 268 characters per segment **Bulk response format (multiple destinations):** ``` ||,||,... ``` **Mid-batch abort scenarios:** - If any error other than an invalid destination occurs, the batch is aborted immediately. - If credits are exhausted mid-batch, processing stops and `1025|` is appended. > **Retry Policy:** Do NOT retry for any error code except `1709`. > For `1715`, do not re-submit the same message. - [Schedule SMS](https://developer.rmlconnect.net/route-mobile-project/reference/schedulesms.md): Schedule an SMS for delivery at a future date and time. - [Send Personalised SMS](https://developer.rmlconnect.net/route-mobile-project/reference/sendpersonalisedsms.md): Send different message content to multiple destination numbers in a single API call. **Bulk response format:** ``` ||,||,... ``` **Mid-batch abort:** If credits are exhausted mid-batch, processing stops and `1025|` is appended to the response. - [Send Unicode / Acculync SMS](https://developer.rmlconnect.net/route-mobile-project/reference/sendunicodeacculyncsms.md): Single endpoint for sending Unicode or English SMS messages with optional Acculync link tracking and URL shortening. **Plain Unicode/English SMS** — Pass only the core parameters (`username`, `password`, `source`, `destination`, `message`). Content is auto-detected and routed as Unicode or plain English accordingly. **Acculync Tracking SMS** — Additionally pass the Acculync parameters (`tagname`, `toshorten`, `tobeshorten`, `isCL`) to enable link shortening and click tracking. - [Send Personalised SMS with Acculync Tracking](https://developer.rmlconnect.net/route-mobile-project/reference/sendacculyncsms.md): Customer-personalised SMS submission with Acculync link shortening and click tracking over the secured 8443 endpoint. - [Submit SMS with Token](https://developer.rmlconnect.net/route-mobile-project/reference/submitsmswithtoken.md): Submit an SMS using a pre-generated authentication token instead of passing credentials with every request. Obtain the token from the Token Generation API. - [JSON Bulk SMS](https://developer.rmlconnect.net/route-mobile-project/reference/sendjsonbulksms.md): Submit one or more SMS messages using a JSON request body. Suitable for bulk integrations where multiple submissions can be batched in a single call. **Bulk response format:** Each item in the response array corresponds to a message in the request. **Mid-batch abort:** If credits are exhausted mid-batch, processing stops and the remaining messages will not be submitted. - [Check Account Credit Balance](https://developer.rmlconnect.net/route-mobile-project/reference/checkcredits.md): Returns the current credit balance for the account. Available over both HTTPS (recommended) and HTTP (legacy). Use `https://api.rmlconnect.net` or `https://api.rmlconnect.net:8443` for secured access, or `http://api.rmlconnect.net` for non-secured access. - [Generate Authentication Token](https://developer.rmlconnect.net/route-mobile-project/reference/generatetoken.md): Generates an authentication token using account credentials. Use the returned token with the Message Submission with Token API to avoid passing credentials on every request. - [Download Coverage Map](https://developer.rmlconnect.net/route-mobile-project/reference/downloadcoveragemap.md): Direct download of the route detail / coverage map associated with the account. Returns an Excel file. Uses the client portal base URL (`https://client.rmlconnect.net`). - [Generate and Send OTP](https://developer.rmlconnect.net/route-mobile-project/reference/generateotp.md): Generates a One-Time Password and delivers it to the specified MSISDN. The OTP length and expiry time can be configured per request. - [Verify OTP](https://developer.rmlconnect.net/route-mobile-project/reference/verifyotp.md): Verifies an OTP submitted by an end user against the OTP previously generated via the OTP Generation API. > **Note:** This API uses a different set of response codes from the OTP Generation API. - [Moengage Integration](https://developer.rmlconnect.net/route-mobile-project/reference/submitmoengagesms.md): Endpoint for integrating the SGN SMS platform with the Moengage customer engagement platform. Authentication is via a static `Authorization` header token provided by Route Mobile. > **Note:** This endpoint uses HTTP POST but accepts parameters as query strings > rather than a JSON body. This is by design for Moengage platform compatibility — > ensure your integration passes parameters in the URL query string, not the request body. - [Webengage Integration](https://developer.rmlconnect.net/route-mobile-project/reference/submitwebengagesms.md): Endpoint for integrating the SGN SMS platform with the Webengage customer engagement platform. Authentication is via a static `Authorization` header token provided by Route Mobile. - [Login API](https://developer.rmlconnect.net/route-mobile-project/reference/loginapi.md): Login APIs provide a secure and standardized way for end users to add user authentication to their applications. Only authorized users can access sensitive resources or perform specific actions within the application after entering the user authentication details. **By default, the JSON Web Token (JWT) validity periods are set to one hour.** - [WBP Account Details](https://developer.rmlconnect.net/route-mobile-project/reference/getaccountdetails.md): The WBP Account Details endpoint fetches the account details for the WhatsApp business profile by entering the authorization token key. - [Profile Photo API](https://developer.rmlconnect.net/route-mobile-project/reference/uploadprofilephoto.md): The Profile Photo API endpoint uploads the profile photo for account and updates the account details for the WhatsApp business profile by entering the authorization token key. - [View Template Message](https://developer.rmlconnect.net/route-mobile-project/reference/viewtemplatemessage.md): View template messages added to the WhatsApp Business account. - [Create Template](https://developer.rmlconnect.net/route-mobile-project/reference/createtemplate.md): Create a template for your message. Learn more about [different WhatsApp templates](https://routemobile.github.io/WhatsApp-Business-API/WBS.html#tag/WhatsApp-Messaging-Template-API/operation/createTemplate). - [Send Template and Session Messages API](https://developer.rmlconnect.net/route-mobile-project/reference/sendsessionmessageapi.md): Send Template and Session Messages API can be used to send either template or session messages to customers. Learn more about [WhatsApp template and session message APIs](https://routemobile.github.io/WhatsApp-Business-API/WBS.html#tag/WhatsApp-Messaging-Template-API/operation/sendSessionMessageApi). - [Get Template Media ID](https://developer.rmlconnect.net/route-mobile-project/reference/media-idapis.md): The Generate Media ID endpoint is used to generate a unique ID for the media file. - [Generate Media ID API](https://developer.rmlconnect.net/route-mobile-project/reference/media-idapi.md): The Generate Media ID endpoint is used to generate a unique ID for the media file. It supports both file uploads and media file URLs. - [Edit Template](https://developer.rmlconnect.net/route-mobile-project/reference/edittemplate.md): The Edit Template API allows you to edit a WhatsApp Business template by providing a new template name and updated components. - [Delete Template](https://developer.rmlconnect.net/route-mobile-project/reference/deletetemplate.md): The Delete Template API allows you to delete a WhatsApp Business template by providing a template name. - [File Upload](https://developer.rmlconnect.net/route-mobile-project/reference/fileupload.md): The File Upload API sends multiple messages to users in a single upload. - [Send Bulk Campaign](https://developer.rmlconnect.net/route-mobile-project/reference/sendbulkcampaign.md): The Send Bulk Campaign API sends messages in bulk to multiple users, manages large-scale campaigns, and reduces the workload for marketers or business owners. - [Upload File](https://developer.rmlconnect.net/route-mobile-project/reference/uploadfile.md): Upload the product feed file. - [Create Product Feed](https://developer.rmlconnect.net/route-mobile-project/reference/createproductfeed.md): Create a feed of products for a WhatsApp Business account. - [Update Product Feed](https://developer.rmlconnect.net/route-mobile-project/reference/updateproductfeed.md): Update an existing feed of products for a WhatsApp Business account. - [Delete product Feed](https://developer.rmlconnect.net/route-mobile-project/reference/deleteproductfeed.md): Delete an existing feed of products for a WhatsApp Business account. - [Fetch Product Feed Details](https://developer.rmlconnect.net/route-mobile-project/reference/fetchproductfeeddetails.md): Fetch product feed details, which is used to retrieve details about a specific product feed. The product feed includes a comma-separated list of field names: - retailer_id: The ID of the retailer associated with the product. - name: The name of the product. - price: The price of the product. - availability: The availability status of the product. - id: The ID of the product. - description: The description of the product. - color: The color of the product. - size: The size of the product. - condition: The condition of the product. - product_type: The type of product. - quantity_to_sell_on_facebook: The quantity of the product to be sold on Facebook. - url: The URL of the product. - gender: The gender for which the product is intended. - age_group: The age group for which the product is intended. - sale_price: The sale price of the product. - mpn: The manufacturer part number of the product. - sale_price_effective_date: The effective date range of the sale price. - brand: The brand of the product. - custom_label_0: A custom label for the product. - [Fetch All Product Feed](https://developer.rmlconnect.net/route-mobile-project/reference/fetchallproductfeed.md): Fetch a list of all product feeds associated with a WhatsApp Business account. To use this endpoint, specify the necessary authorization token credentials. - [Fetch Catalog Details](https://developer.rmlconnect.net/route-mobile-project/reference/fetchcatalogdetails.md): Fetch details about a specific product catalog associated with a WhatsApp Business account. The fields information includes a comma-separated list: - name: The name of the product catalog. - product_count: The total number of products in the product catalog. - schedule: The schedule for updating the product catalog. - latest_upload: The date and time of the most recent upload to the product catalog. - retailer_id: The ID of the retailer associated with the product catalog. - price: The price of the product. - availability: The availability status of the product. - id: The ID of the product. - description: The description of the product. - color: The color of the product. - size: The size of the product. - condition: The condition of the product. - product_type: The type of product. - quantity_to_sell_on_facebook: The quantity of the product to sell on Facebook. - url: The URL of the product. - gender: The gender of the product. - age_group: The age group of the product. - sale_price: The sale price of the product. - mpn: The manufacturer part number of the product. - sale_price_effective_date: The effective date of the sale price of the product. - brand: The brand of the product. - custom_label_0: The custom label of the product. - image_url: The URL of the product image. - [Fetch Schedule Product Feed Details](https://developer.rmlconnect.net/route-mobile-project/reference/fetchscheduleproductfeeddetails.md): Fetch scheduled product feeds associated with a WhatsApp Business account. - [Fetch Errors](https://developer.rmlconnect.net/route-mobile-project/reference/fetcherrors.md): The Fetch Errors API calls all error outputs for the particular upload session ID. - [Create Report](https://developer.rmlconnect.net/route-mobile-project/reference/createreport-1.md): Create reports for your WhatsApp Business account. Use the projections while creating a new report. The available projection fields are: - country_code: The country code of the phone number. - msisdn: The phone number of the customer. - message_type: The type of the message, such as text, image, video, and document. - message_payload: The content of the message. - request_id: The request ID of the message. - conversation_id: The conversation ID of the message. - message_id: The message ID of the message. - submit_timestamp: The timestamp when the message was submitted. - sent_timestamp: The timestamp when the message was sent. - delivery_timestamp: The timestamp when the message was delivered. - read_timestamp: The timestamp when the message was read. - failed_timestamp: The timestamp when the message failed to be delivered. - deleted_timestamp: The timestamp when the message was deleted. - extra: Any additional metadata associated with the message. - pricing_model: The pricing model for the message. - [Create Campaign Specific Report](https://developer.rmlconnect.net/route-mobile-project/reference/createcampaignspecificreport.md): Create a campaign-specific report for WhatsApp Business account. The projections field contains a comma-separated list of field names: - country_code: The country code of the recipient's phone number. - msisdn: The recipient's phone number. - message_type: The type of the message, such as text, image, and video. - message_payload: The content of the message. - request_id: The unique ID assigned to the message by the WhatsApp Business API. - conversation_id: The ID of the conversation thread. - message_id: The ID of the message. - submit_timestamp: The timestamp of when the message was submitted to the API. - sent_timestamp: The timestamp of when the message was sent to the recipient. - delivery_timestamp: The timestamp of when the message was delivered to the recipient. - read_timestamp: The timestamp of when the message was marked as read by the recipient. - failed_timestamp: The timestamp of when the message failed to be delivered. - deleted_timestamp: The timestamp of when the message was deleted. - extra: Additional information about the message. - pricing_model: The pricing model used for the message. - scheduled_time: The scheduled time of the message, if it was a scheduled message. - [Fetch Report URL](https://developer.rmlconnect.net/route-mobile-project/reference/fetchreporturl.md): Fetch campaign data from the provided URL by entering the report_id parameter details. - [View Campaign Summary](https://developer.rmlconnect.net/route-mobile-project/reference/viewcampaignsummary.md): View the campaign summary for the WhatsApp Business account. Ensure that you provide an authentication token in the request headers for the successful API call. - [View Report Summary](https://developer.rmlconnect.net/route-mobile-project/reference/viewreportsummary.md): View report summary for the WhatsApp Business account. - [Optin Create Report](https://developer.rmlconnect.net/route-mobile-project/reference/optindownload.md): The Optin Create Report endpoint is used to report user opt-ins for receiving messages from a business. - [Download Optin Report](https://developer.rmlconnect.net/route-mobile-project/reference/downloadoptin.md): The Download Optin Report endpoint is used to download the user opt-ins report for receiving messages from a business. - [Template Wise Count](https://developer.rmlconnect.net/route-mobile-project/reference/gettemplatewisecount.md): The Template Wise Count endpoint is used to count approved templates associated with a WhatsApp Business account. - [Create Optin](https://developer.rmlconnect.net/route-mobile-project/reference/createoptin.md): Create optin for the WhatsApp Business account. - [Create Optin and Optout](https://developer.rmlconnect.net/route-mobile-project/reference/createoptinout.md): Create optin/optout for the WhatsApp Business account. - [Check Optin](https://developer.rmlconnect.net/route-mobile-project/reference/checkoptin.md): Check optin if a particular phone number has opted-in to receive messages from the WhatsApp Business account. - [WhatsApp Client Callback](https://developer.rmlconnect.net/route-mobile-project/reference/whatsappclientcallback.md): Client Callback APIs allow you to receive real-time notifications (callbacks) for events that occur on your WhatsApp Business account. These callbacks are triggered by events that occur on the WhatsApp server, and are delivered to a URL that you specify in your webhook configuration. For more information, see the [Route Mobile WhatsApp OpenAPI Specifications](https://routemobile.github.io/WhatsApp-Business-API/WBS.html). ## Callback Error Codes | **Code** | **Text** | **Description** | | --- | --- | --- | | 400 | Media download error | There was an error while downloading media. | | 401 | Group does not exist | The specified group does not exist. | | 402 | Others | An unspecified error occurred. | | 403 | Error code for blacklisting | The given number is blacklisted. | | 408 | Message is not valid | The message is not valid or malformed. | | 410 | Message expired | The message has expired and cannot be delivered. | | 429 | Rate limit hit | The rate limit for API calls has been reached. | | 430 - 433 | Others | Unspecified errors occurred. | | 470 | Re-engagement message | The message is a re-engagement message. | | 471 | Spam Rate limit | The rate limit for sending spam messages has been reached. | | 472 | User's number is part of an experiment | The user's number is part of an experiment and cannot be used. | | 500 | Unknown Error | An unknown or unexpected error occurred. | | 1000 | Others | Unspecified errors occurred. | | 1001 | Message too long | The message exceeds the maximum length allowed. | | 1002 | Invalid recipient type | The recipient type specified is not valid. | | 1003 | Not a group participant | The user is not a participant of the group. | | 1004 | Resource already exists | The resource being created already exists. | | 1005-1006 | Others | Unspecified errors occurred. | | 1008 | Required parameter is missing | A required parameter for the API call is missing. | | 1009 | Parameter value is not valid | The value provided for a parameter is not valid. | | 1010 | Parameter is not required | A parameter that was provided is not required for the API call. | | 1011-1011 | Others | Unspecified errors occurred. | | 1012 | Group is unknown | The specified group is unknown. | | 1013 | User is not valid | The specified user is not valid. | | 1014 | Corrupt Image | The image provided is corrupt or invalid. | | 1015-1018 | Others | Unspecified errors occurred. | | 1019 | Not a group admin | The user is not an admin of the group. | | 1020 | Bad group | The specified group is invalid or bad. | | 1021 | Bad User | The specified user is invalid or bad. | | 1022-1024 | Others | Unspecified errors occurred. | | 1025 | Invalid Request | The API request is invalid. | | 1026 | Receiver Incapable | The receiver is incapable of receiving the message. | | 2000 | Template Param Count Mismatch | The number of parameters provided for a template does not match the required count. | | 2001 | Template Missing | The specified template does not exist. | | 2002 | Template Fetch Failed | Failed to fetch the template. | | 2003 | Template Pack Missing | The template pack is missing. | | 2004 | Template Param Length Too Long | The length of a parameter in the template is too long. | | 2005 | Template Hydrated Text Too Long | The length of the hydrated text in the template is too long. | | 2006 | Template White Space Policy Violated | The template violates the white space policy. | | 2007 | Template Format Character Policy Violated | The template violates the format character policy. | | 2008 | Template Media Format Unsupported | The media format in the template is unsupported. | | 2009 | Template Required Component Missing | A required component in the template is missing. | | 2010 | Template Invalid Hydrated URL | The hydrated URL in the template is invalid. | | 2011 | Template Invalid Phone Number | The phone number in the template is invalid. | | 2012 | Template Parameter Format Mismatch | The format of a parameter in the template is mismatched. | | 2013 | Template Buttons Unsupported | The buttons in the template are unsupported. | | 0 | AuthException | An authentication exception occurred. | | 3 | API Method | An error occurred with the API method. | | 10 | Permission Denied | The user does not have the necessary permissions to perform the requested action. | | 190 | Access token has expired | The access token used for authentication has expired. | | 200-299 | API Permission | The API call requires specific permissions, and the user does not have them. | | 4 | API Too Many Calls | The API call limit has been exceeded. | | 80007 | Rate limit issues | There are issues with the rate limits for API calls. | | 130429 | Rate limit hit | The rate limit for API calls has been reached. | | 131048 | Spam rate limit hit | The rate limit for sending spam messages has been reached. | | 131056 | (Business Account, Consumer Account) pair rate limit hit | The rate limit for a specific pair of business and consumer accounts has been reached. | | 368 | Temporarily blocked for policy violations | The user or account has been temporarily blocked due to policy violations. | | 131031 | Account has been locked | The user's account has been locked. | | 1 | API Unknown | An unknown error occurred with the API. | | 2 | API Service | An error occurred with the API service. | | 33 | Parameter value is not valid | The value provided for a parameter is not valid. | | 100 | Invalid parameter | The parameter specified in the API call is invalid. | | 131000 | Something went wrong | An unspecified error occurred. | | 131005 | Access denied | Access to the requested resource is denied. | | 131008 | Required parameter is missing | A required parameter for the API call is missing. | | 131009 | Parameter value is not valid | The value provided for a parameter is not valid. | | 131016 | Service unavailable | The requested service is currently unavailable. | | 131021 | Recipient cannot be sender | The recipient of the message cannot be the sender. | | 131026 | Message Undeliverable | The message could not be delivered to the recipient. | | 131042 | Business eligibility payment issue | There is an issue with the payment for business eligibility. | | 131045 | Incorrect certificate | The certificate used for authentication is incorrect. | | 131047 | Re-engagement message | The message is a re-engagement message. | | 131051 | Unsupported message type | The message type is not supported. | | 131052 | Media download error | There was an error while downloading media. | | 131053 | Media upload error | There was an error while uploading media. | | 132000 | Template Param Count Mismatch | The number of parameters provided for a template does not match the required count. | | 132001 | Template does not exist | The specified template does not exist. | | 132005 | Template Hydrated Text Too Long | The length of the hydrated text in the template is too long. | | 132007 | Template Format Character Policy Violated | The template violates the format character policy. | | 132012 | Template Parameter Format Mismatch | The format of a parameter in the template is mismatched. | | 132015 | Template parameter invalid | The parameter in the template is invalid. | | 133000 | Incomplete Deregistration | The deregistration process is incomplete. | | 133004 | Server Temporarily Unavailable | The server is temporarily unavailable. | | 133005 | Two-step verification PIN Mismatch | The two-step verification PIN provided does not match. | | 133006 | Phone number re-verification needed | Phone number re-verification is required. | | 133008 | Too Many two-step verification PIN Guesses | Too many incorrect guesses for the two-step verification PIN. | | 133009 | Two-step verification PIN Guessed Too Fast | The two-step verification PIN was guessed too quickly. | | 133010 | Phone number Not Registered | The phone number is not registered. | | 135000 | Generic user error | A generic error occurred for the user. | ## Template Status Logs | **Template Status**| **Logs** | | --- | --- | |Template Approved | {"product": "whatsapp", "component": "whatsapp-callback-event-worker", "level": "debug", "timestamp": "2023-11-02 07:40:04.402735", "message": {"URL": "xxxxxxxxxxxxxxxxx", "data": {"statuses": [{"id": "xxxxxxxxxxxxxx", "template_name": "xxxxx", "template_id": xxxxxxxxxxxxxx, "template_language": "en", "reason": "NONE", "status": "APPROVED", "timestamp": xxxxxxxx, "type": "event", "information": null}], "brand_msisdn": "{phone}"}, "status": 200, "response_time": 0.0xxxxxxxxxxxxxx, "current_time": "xx:xx:xx.xxxxxx", "response": "{\"success\":true}"}}| | Template Paused | {"product": "whatsapp", "component": "whatsapp-callback-event-worker", "level": "debug", "timestamp": "2023-11-02 07:37:58.285408", "message": {"URL": "xxxxxxxxxxxxxxxxxxxxx", "data": {"statuses": [{"id": "xxxxxxxxxxxxxxx", "template_name": "abc__1", "template_id": xxxxxxxxxxxxxxx, "template_language": "en", "reason": "NONE", "status": "PAUSED", "timestamp": xxxxxxxxxx, "type": "event", "information": {"title": "FIRST_PAUSE", "description": "Your WhatsApp message template has been paused for x hours until xxx x at xx:xx AM UTC because it had issues."}}], "brand_msisdn": "{phone}"}, "status": 200, "response_time": 0.0xxxxxxxxxxxxxxx, "current_time": "xxxx-xx-xx xx:xx:xx.xxxxxx", "response": "{\"success\":true}"}} | |Template Disabled| {"product": "whatsapp", "component": "whatsapp-callback-event-worker", "level": "debug", "timestamp": "2023-11-02 09:57:45.920074", "message": {"URL": "xxxxxxxxxxxxxxxxxxxxxx", "data": {"statuses": [{"id": "xxxxxxxxxxxxxxxxx", "template_name": "xxxxxxxxxxxxxxx", "template_id": xxxxxxxxxxxxxx, "template_language": "en_US", "reason": "NONE", "status": "FLAGGED", "timestamp": xxxxxxxxxx, "type": "event", "information": null}], "brand_msisdn": "{phone}"}, "status": 200, "response_time": 0.011070728302001953, "current_time": "xxxx-xx-xx xx:xx:xx.xxxxxx", "response": "{\"status\":\"ok\"}\n"}} | |Template Deleted |{"product": "whatsapp", "component": "whatsapp-callback-event-worker", "level": "debug", "timestamp": "2023-11-02 10:36:44.798440", "message": {"URL": "xxxxxxxxxxxxxxxxxxxxxxxx", "data": {"statuses": [{"id": "xxxxxxxxxxxxxxxx", "template_name": "testing_02_2023", "template_id": xxxxxxxxxxxxxx, "template_language": "en_US", "reason": "NONE", "status": "PENDING_DELETION", "timestamp": xxxxxxxxxxx, "type": "event", "information": null}], "brand_msisdn": "{phone}"}, "status": 200, "response_time": 0.0xxxxxxxxxxxxxxxxxx, "current_time": "xxxx-xx-xx xx:xx:xx.xxxxxx", "response": "{\"status\":\"ok\"}\n"}}| - [Login API](https://developer.rmlconnect.net/route-mobile-project/reference/loginapi2-1.md): Login APIs provide a secure and standardized way for end users to add user authentication to their applications. Only authorized users can access sensitive resources or perform specific actions within the application after entering the user authentication details. **By default, the JSON Web Token (JWT) validity periods are set to one hour.** - [RCS Messages API](https://developer.rmlconnect.net/route-mobile-project/reference/texttemplate.md): The Rich Communication Services (RCS) Business Messaging API is a communication protocol that allows businesses to send different types of messages beyond traditional text messages. The RCS Business Messaging API allows businesses to send different types of messages that include: - **Notification API:** Standard messages that send plain text or media content. - **Session API:** Standard text messages that send plain text content as part of a campaign. - **India Template API:** Create interactive and visually rich content to engage customers. - [Bulk Upload Campaign](https://developer.rmlconnect.net/route-mobile-project/reference/bulkcampaignuploadrcs.md): Bulk Upload Campaign APIs send messages to many recipients simultaneously using a batch upload process. It allows businesses to efficiently send personalized and interactive messages to their customers at scale. - [Payment API](https://developer.rmlconnect.net/route-mobile-project/reference/sendbilltouserrcs.md): The Payment Template API allows businesses to integrate payment functionality into their RCS messages. With this API, businesses can create payment templates that enable users to make secure payments directly within the RCS messaging experience. The API will use the provided phone number to send the payment template message to the recipient via RCS. The template will include the specified variables and their corresponding values, allowing you to customize the payment details for each recipient. - [Typing Indicator](https://developer.rmlconnect.net/route-mobile-project/reference/typingindicator.md): The Typing Indicator API indicates to the recipient that the bot or sender is typing a response. - [Marking messages as Read](https://developer.rmlconnect.net/route-mobile-project/reference/markingmessagesasread.md): The API will mark the messages as read for the recipient, indicating they have been viewed or acknowledged. This API is useful for tracking the delivery and engagement of messages sent through RCS business messaging. - [Revoke with SMS fallback](https://developer.rmlconnect.net/route-mobile-project/reference/revokewithsmsfallback.md): The API will handle the revocation of the specified message for the recipient. - [Callback](https://developer.rmlconnect.net/route-mobile-project/reference/post-callback.md): Use the Callback API to receive real-time RCS notifications of incoming messages and other events. - [File Upload API](https://developer.rmlconnect.net/route-mobile-project/reference/fileuploadrcs.md): File Upload API is used to upload files for a given called bot name which is usually supported for a file server. - [Make a Tester](https://developer.rmlconnect.net/route-mobile-project/reference/managementrcs.md): Add Tester is a Management API used to add a bot for testing purpose for all RCS Components - [List all Testers](https://developer.rmlconnect.net/route-mobile-project/reference/managementrcs-1.md): List all Testers is a Management API used to retrieve all bot number for testing purpose for all RCS Components - [Bulk Whitelist / Blacklist Numbers](https://developer.rmlconnect.net/route-mobile-project/reference/bulkdndset.md): The Bulk DND Set API allows you to whitelist or blacklist a batch of phone numbers for a specific RCS bot. Provide the URL of a previously uploaded CSV file (from the File Upload API) containing the phone numbers, and set `dnd_mode` to control whether those numbers are blacklisted (`true`) or whitelisted (`false`). - [Bulk Capability Check](https://developer.rmlconnect.net/route-mobile-project/reference/getcapabilitydetails.md): The Bulk Capability Check API retrieves RCS capability details for phone numbers that were submitted for capability checking. Use the date range and optional status filter to paginate through results. - [Check Bulk Capability](https://developer.rmlconnect.net/route-mobile-project/reference/checkbulkcapability.md): Upload a CSV file containing phone numbers to trigger a bulk RCS capability check. The file should contain one phone number per row. After submission, use the Fetch Bulk Capability Details API to retrieve the results once processing is complete. - [Create Optin API](https://developer.rmlconnect.net/route-mobile-project/reference/optinrcs.md): Create Optin API is used to create optin for a given called bot name which is usually supported along with channel. - [Create Template APi](https://developer.rmlconnect.net/route-mobile-project/reference/createtemplatercs.md): RCS Create Template APIs allows businesses to create existing templates created by using RML Panel which can be used efficiently send personalized and interactive messages to their customers at scale. - [Update Template APi](https://developer.rmlconnect.net/route-mobile-project/reference/updatetemplatercs.md): RCS Update Template APIs allows businesses to update existing templates created by using RML Panel which can be used efficiently send personalized and interactive messages to their customers at scale. - [Get Template API](https://developer.rmlconnect.net/route-mobile-project/reference/gettemplatercs.md): RCS Get Template API is used to retrieve TEMPLATE specified when category,name,bot_name, user_name, template_id, page_no and limit are mentioned to locate the template for testing purpose for all RCS Components - [Delete Template API](https://developer.rmlconnect.net/route-mobile-project/reference/deletetemplatercs.md): RCS Delete Template API is used to delete TEMPLATE specified when name and bot_name are mentioned to locate the template for testing purpose for all RCS Components - [Get Template Status APi](https://developer.rmlconnect.net/route-mobile-project/reference/gettemplatestatusrcs.md): RCS Get Template Status API allows businesses to get existing templates created by using RML Panel using parameters templateName and bot_name which can be used efficiently send personalized and interactive messages to their customers at scale. - [Get Single Template APi](https://developer.rmlconnect.net/route-mobile-project/reference/getsingletemplatercs.md): RCS Get Single Template API allows businesses to get one of existing templates created by using RML Panel using parameters name and bot_name which can be used efficiently send personalized and interactive messages to their customers at scale. - [Add a new SMTP user](https://developer.rmlconnect.net/route-mobile-project/reference/addsmtpuser.md): Creates a new SMTP sub-user with defined sending limits. - [Edit an existing SMTP user](https://developer.rmlconnect.net/route-mobile-project/reference/editsmtpuser.md): Updates the sending limits or status of an SMTP sub-user. - [Reset SMTP user password](https://developer.rmlconnect.net/route-mobile-project/reference/resetsmtppassword.md): Generates a new password for the specified SMTP sub-user. - [List all SMTP users](https://developer.rmlconnect.net/route-mobile-project/reference/listsmtpusers.md): Returns a list of all SMTP sub-users associated with the account. - [Add a sending domain](https://developer.rmlconnect.net/route-mobile-project/reference/addsendingdomain.md): Registers a new sending domain to the account. - [Verify DKIM and SPF records](https://developer.rmlconnect.net/route-mobile-project/reference/checksendingdomain.md): Checks whether DKIM and SPF DNS records are correctly configured for the domain. - [Verify sending domain via email](https://developer.rmlconnect.net/route-mobile-project/reference/verifysendingdomain.md): Sends a verification instruction email to `mailbox@domain`. - [List sending domains](https://developer.rmlconnect.net/route-mobile-project/reference/listsendingdomains.md): Returns all sending domains registered to the account with their DNS validation status. - [Delete a sending domain](https://developer.rmlconnect.net/route-mobile-project/reference/deletesendingdomain.md): Removes the specified sending domain from the account. - [Add a tracking domain](https://developer.rmlconnect.net/route-mobile-project/reference/addtrackingdomain.md): Registers a custom tracking domain for open and click tracking. - [Check tracking domain CNAME](https://developer.rmlconnect.net/route-mobile-project/reference/checktrackingdomain.md): Validates whether the CNAME record for the tracking domain is correctly configured. - [List tracking domains](https://developer.rmlconnect.net/route-mobile-project/reference/listtrackingdomains.md): Returns all tracking domains registered to the account. - [Delete a tracking domain](https://developer.rmlconnect.net/route-mobile-project/reference/deletetrackingdomain.md): Removes the specified tracking domain from the account. - [Add a webhook](https://developer.rmlconnect.net/route-mobile-project/reference/addwebhook.md): Registers a new webhook URL to receive email event notifications. **Supported events:** `send`, `open`, `click`, `soft_bounce`, `hard_bounce`, `spam` **Important:** The webhook URL must respond with `God bless you, SendClean` to pass the validation check. SendClean signs webhook POST requests with an HMAC-SHA1 signature in the `X-SendCleanTES-SIGNATURE` header for optional verification. See the Webhook Authentication section for details. - [Edit a webhook](https://developer.rmlconnect.net/route-mobile-project/reference/editwebhook.md): Updates the configuration of an existing webhook. - [Reset webhook authentication key](https://developer.rmlconnect.net/route-mobile-project/reference/keyresetwebhook.md): Generates a new authentication/signing key for the specified webhook. **Note:** SendClean immediately begins using the new key. To avoid dropping webhook batches, return a non-200 status for any batches that fail signature verification, and update your application with the new key before retrying. - [List all webhooks](https://developer.rmlconnect.net/route-mobile-project/reference/listwebhooks.md): Returns all webhooks registered to the account. - [Delete a webhook](https://developer.rmlconnect.net/route-mobile-project/reference/deletewebhook.md): Permanently removes a webhook from the account. - [Get webhook details](https://developer.rmlconnect.net/route-mobile-project/reference/getwebhookinfo.md): Returns detailed information about a specific webhook, including delivery stats. - [Send a transactional email](https://developer.rmlconnect.net/route-mobile-project/reference/sendmail.md): Sends a new transactional email via the specified SMTP sub-user. Either `html` or `text` content is required in the message body (both may be provided). Use the `headers` object to control tracking, signing, and routing behaviour. Use `X-Unique-Id` in headers to tag messages for later retrieval via `/messages/getMessageInfo`. - [Send email using a saved template](https://developer.rmlconnect.net/route-mobile-project/reference/sendtemplate.md): Sends a transactional email using a pre-created template. Use `dynamic_value` to replace template placeholders (case-sensitive field names). - [Send template email via HTTP GET](https://developer.rmlconnect.net/route-mobile-project/reference/sendtemplatehttpget.md): Sends a transactional email using a template via HTTP GET. Designed for simple integrations such as IVR webhooks where POST with JSON body is not practical. **All parameter values must be URL-encoded.** Example: ``` GET https://api.sendclean.net/v1.0/messages/sendTemplateHTTPGet?owner_id=YOUR_ID&token=YOUR_TOKEN &smtp_user_name=smtp12345&template_id=TMPL_ID&subject=Hello &from_email=info%40example.com&to=customer%40example.com &dynamic_value%5BNAME%5D=John&dynamic_value%5BEmail%5D=john%40example.com ``` - [Get message delivery and engagement info](https://developer.rmlconnect.net/route-mobile-project/reference/getmessageinfo.md): Retrieves delivery status, open data, and click data for messages matching a given `X-Unique-Id`. Supports pagination via `skip_page`. - [Get account/user details](https://developer.rmlconnect.net/route-mobile-project/reference/getuserdetails.md): Returns profile and account information for the authenticated user. - [Login API](https://developer.rmlconnect.net/route-mobile-project/reference/loginapi2.md): Login APIs provide a secure and standardized way for end users to add user authentication to their applications. Only authorized users can access sensitive resources or perform specific actions within the application after entering the user authentication details. **By default, the JSON Web Token (JWT) validity periods are set to one hour.** - [Viber Client Callback](https://developer.rmlconnect.net/route-mobile-project/reference/viberclientcallback.md): Viber Client Callback APIs allow you to receive real-time notifications for events that occur on your Viber Business Messaging account. These callbacks are triggered by events that occur on the Viber server, and are delivered to a URL that you specify in your webhook configuration. - [Viber Send Single Messages APIs](https://developer.rmlconnect.net/route-mobile-project/reference/singlevideotext.md): Viber Business Send Messages APIs allow businesses to send a variety of message types to their users on the Viber platform. These APIs enable businesses to engage with their customers, deliver personalized content, and provide interactive experiences through Viber's messaging platform. Here are the supported Viber Business Send Single Message types: - **Single Text:** Send a plain text message to a recipient. - **Single Text Button:** Send a text message with an action button. - **Single Text Button Image:** Send a message combining text, a button, and an image. - **Single Text Image:** Send a message combining text and an image. - **Single Image:** Send a standalone image message. - **Single File:** Send a file/document attachment. - **Single Video:** Send a video message. - **Single Video Text:** Send a video with accompanying text. - **Single Video Button Text:** Send a video with text and an action button. - **Single Video Text Action Button:** Send a video with text and a structured action button object. - **OTP / Verification Message:** Send a one-time password or verification code using a pre-approved template. - **Text Template:** Send a branded text message using an approved template ID. - **Text Message with Fallback:** Send a Viber message with an automatic fallback to WhatsApp or SMS if the recipient is unreachable on Viber. - [Viber Send Campaign Messages APIs](https://developer.rmlconnect.net/route-mobile-project/reference/campaignvideotext.md): Viber Business Send Campaign Messages APIs allow businesses to send bulk campaign messages to multiple users on the Viber platform. A campaign uses a `file_code` returned from the Campaign File Upload API to address recipients. Here are the supported Viber Business Send Campaign Message types: - **Campaign Text:** Send a plain text message to multiple recipients. - **Campaign Text Button:** Send a text message with an action button to multiple recipients. - **Campaign Text Button Image:** Send a message with text, a button, and an image to multiple recipients. - **Campaign Text Image:** Send a message combining text and an image. - **Campaign Image:** Send a standalone image to multiple recipients. - **Campaign File:** Send a file/document attachment to multiple recipients. - **Campaign Video:** Send a video message to multiple recipients. - **Campaign Video Text:** Send a video with accompanying text to multiple recipients. - **Campaign Video Text Action Button:** Send a video with text and a structured action button to multiple recipients. - **Campaign Text Template:** Send a branded text message using an approved template to multiple recipients. - **Campaign with Fallback:** Send a Viber campaign with an automatic fallback to WhatsApp or SMS if recipients are unreachable on Viber. Optionally include `schedule_datetime` and `timezone` to schedule the campaign for a future send time. - [Campaign File Upload](https://developer.rmlconnect.net/route-mobile-project/reference/campaignfileupload.md): The Campaign File Upload API allows businesses to securely upload their contact list or campaign content files to Viber's platform for use in bulk campaigns. Files must be uploaded as binary data using `multipart/form-data`. The following file formats are supported: - **CSV** (`.csv`) — Comma-separated contact list - **Excel** (`.xlsx`, `.xls`) — Spreadsheet contact list - **Plain Text** (`.txt`) — Tab or newline-delimited contact list - **ZIP** (`.zip`) — Archive containing a single CSV file Once uploaded, the API returns a `campaign_id` which is required when sending campaign messages via the Send Campaign Messages API. - [Viber Send Bulk Messages API](https://developer.rmlconnect.net/route-mobile-project/reference/sendbulkmessages.md): The Viber Send Bulk Messages API allows businesses to send campaign messages to multiple recipients at once. The recipients are defined by a `file_code` returned from the Campaign File Upload API. Supported bulk message types include text, image, text+image, text button, text button image, file, video, video+text, video+text+action button, and text template. Fallback delivery to SMS or WhatsApp is supported on any message type by including `fallback_channel` and the corresponding `fallback_sms` or `fallback_whatsapp` block inside the payload. Campaigns can be scheduled by providing `schedule_datetime` (format: `YYYY-MM-DD HH:MM:SS`) and `timezone` (e.g. `Asia/Kolkata`). - [Summary Cards](https://developer.rmlconnect.net/route-mobile-project/reference/getsummarycards.md): Returns high-level summary metrics for a given date range, including total messages sent, delivered, seen, and failed. Used to populate dashboard summary card widgets. - [Graph Report](https://developer.rmlconnect.net/route-mobile-project/reference/getgraphreport.md): Returns time-series data points for message delivery metrics over a specified date range. Used to populate trend graphs on the reporting dashboard. - [Media Cards](https://developer.rmlconnect.net/route-mobile-project/reference/getmediacards.md): Returns a breakdown of message delivery metrics grouped by media/message type (text, image, video, file, etc.) for a given date range. Used to populate media-type breakdown cards on the reporting dashboard. - [Campaign Report](https://developer.rmlconnect.net/route-mobile-project/reference/getcampaignreport.md): Returns a paginated list of campaigns and their delivery metrics for a given date range. Used to view per-campaign performance on the reporting dashboard. - [Daily Tabular Report](https://developer.rmlconnect.net/route-mobile-project/reference/getdailytabularreport.md): Returns a paginated, per-message tabular report for a given date range. Each record contains the phone number, message type, delivery status, and timestamps. Supports filtering by timezone, message type, service type, and optionally by a specific phone number. - [List Viber Templates](https://developer.rmlconnect.net/route-mobile-project/reference/listvibertemplates.md): Returns a paginated list of approved Viber message templates associated with the account. Supports filtering by a specific template ID. - [Add Viber Template](https://developer.rmlconnect.net/route-mobile-project/reference/addvibertemplate.md): Creates a new Viber message template for the account. Templates must be submitted with a unique name, message syntax (with `{{parameter}}` placeholders), the message type, and the operator-assigned template ID. Templates require approval before they can be used in messages. - [Fetch Reports](https://developer.rmlconnect.net/route-mobile-project/reference/fetchreports.md): Returns a paginated list of generated report records for a given date range. Each record includes the report status, file path, and metadata. Use the `file_path` value from a completed report to call the Download Report endpoint. - [Create Report](https://developer.rmlconnect.net/route-mobile-project/reference/createreport.md): Triggers the generation of a new downloadable report for a given date range. The report is created asynchronously — use the Fetch Reports endpoint to check status, then the Download Report endpoint once the status is `completed`. - [Download Report](https://developer.rmlconnect.net/route-mobile-project/reference/downloadreport.md): Downloads a generated report file by its file name. The file name is obtained from the `file_path` field in the Fetch Reports response. The report is returned as a ZIP archive containing a CSV file.