{"items":[{"type":"link","label":"Promotexter API","link":"/api","routeSlug":"/api"},{"type":"separator","label":"Get started"},{"type":"group","label":"Account Registration","link":"/api/account-registration","routeSlug":"/api/account-registration","items":[]},{"type":"group","label":"IP Whitelisting","link":"/api/ip-whitelisting","routeSlug":"/api/ip-whitelisting","items":[]},{"type":"group","label":"API Authentication","link":"/api/api-authentication","routeSlug":"/api/api-authentication","items":[{"label":"Generate Promotexter token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/api-authentication/generatepromotextertoken","routeSlug":"/api/api-authentication/generatepromotextertoken","metadata":{"seo":{"title":"Generate Promotexter token","description":"Generate a Promotexter token using the client token and expiresInSeconds required field.<br><br><b>Authentication:</b> use a valid <b>client token</b> in the Authorization header using the format <code>Bearer [client-token]</code>.<br><br><b>Rate limit:</b> maximum of 5 requests per minute. Once exceeded, error <code>40002: Too many requests.</code> is returned."}},"httpPath":"/generate-token"}]},{"type":"separator","label":"Account"},{"type":"group","label":"Account Balance","link":"/api/account-balance","routeSlug":"/api/account-balance","items":[{"label":"Get account balance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/account-balance/getaccountbalance","routeSlug":"/api/account-balance/getaccountbalance","metadata":{"seo":{"title":"Get account balance","description":"Retrieves the current account balance available for messaging or other service usage.<br><br><b>Authentication options:</b> either use a <b>Promotexter token</b> in the Authorization header, or provide apiKey and apiSecret as query parameters. Refer to the <a href=\"https://promotexter-api.redocly.app/api/api-authentication\" target=\"_blank\" rel=\"noopener noreferrer\">API Authentication</a> section for details.<br><br>"}},"httpPath":"/api/account/balance"}]},{"type":"separator","label":"Business Messages"},{"type":"group","label":"Viber Business Messaging","link":"/api/viber-business-messaging","routeSlug":"/api/viber-business-messaging","items":[{"label":"Send Viber with optional SMS fallback","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/viber-business-messaging/sendviber","routeSlug":"/api/viber-business-messaging/sendviber","metadata":{"seo":{"title":"Send Viber with optional SMS fallback","description":"Send a Viber message using the required Viber channel ID and recipient fields, choose one message type or template payload, and optionally include SMS fallback, ttl, callback and reference ID fields.<br><br><b>Authentication options:</b> either use a <b>Promotexter token</b> in the Authorization header, or provide apiKey and apiSecret in the request body. Refer to the <a href=\"https://promotexter-api.redocly.app/api/api-authentication\" target=\"_blank\" rel=\"noopener noreferrer\">API Authentication</a> section for details.<br><br>"}},"httpPath":"/viber/send"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Receive Inbound Messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/viber-business-messaging/receiveviberinboundmessageswebhook","routeSlug":"/api/viber-business-messaging/receiveviberinboundmessageswebhook","metadata":{"seo":{"title":"Receive Inbound Messages","description":"Receive Viber inbound messages through your dedicated replyable Viber channel to your configured webhook URL in real-time (via GET method by default).<br>"}},"httpPath":"/your/webhook/path"}]},{"type":"group","label":"WhatsApp Business Messaging","link":"/api/whatsapp-business-messaging","routeSlug":"/api/whatsapp-business-messaging","items":[{"label":"Send WhatsApp with optional SMS fallback","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/whatsapp-business-messaging/sendwhatsapp","routeSlug":"/api/whatsapp-business-messaging/sendwhatsapp","metadata":{"seo":{"title":"Send WhatsApp with optional SMS fallback","description":"Sends a WhatsApp message using Meta-compatible payload structure and optionally enables SMS fallback when WhatsApp delivery fails for supported cases.<br><br><blockquote><p><b>Note:</b> The below WhatsApp error codes will trigger SMS fallback when the required SMS fallback parameters are included in the request. SMS fallback is not supported for reaction messages.</p><ol><li><code>131049</code> - This message was not delivered to maintain healthy ecosystem engagement.</li><li><code>131050</code> - Unable to deliver the message. This recipient has chosen to stop receiving marketing messages on WhatsApp from your business.</li><li><code>131026</code> - Unable to deliver message. Reasons can include the recipient not being a WhatsApp user, not having accepted the latest Terms of Service and Privacy Policy, or using an outdated WhatsApp version.</li><li><code>131047</code> - More than 24 hours have passed since the recipient last replied to the sender number. Send the recipient a template message instead.</li><li><code>131062</code> - Business-scoped User ID (BSUID) recipients are not supported for this message.</li></ol><p>See <a href=\"https://developers.facebook.com/documentation/business-messaging/whatsapp/support/error-codes\" target=\"_blank\" rel=\"noopener noreferrer\">WhatsApp error codes</a>.</p></blockquote><br><b>Authentication options:</b> either use a <b>Promotexter token</b> in the Authorization header, or provide apiKey and apiSecret in the request body. Refer to the <a href=\"https://promotexter-api.redocly.app/api/api-authentication\" target=\"_blank\" rel=\"noopener noreferrer\">API Authentication</a> section for details.<br><br>"}},"httpPath":"/whatsapp/send"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Receive Inbound Messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/whatsapp-business-messaging/receivewhatsappinboundmessageswebhook","routeSlug":"/api/whatsapp-business-messaging/receivewhatsappinboundmessageswebhook","metadata":{"seo":{"title":"Receive Inbound Messages","description":"Receive WhatsApp inbound messages through your WhatsApp channel to your configured webhook URL in real-time (via GET method by default).<br>"}},"httpPath":"/your/whatsapp/webhook/path"}]},{"type":"group","label":"SMS Messaging","link":"/api/sms-messaging","routeSlug":"/api/sms-messaging","items":[{"label":"Send SMS","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/sms-messaging/sendsms","routeSlug":"/api/sms-messaging/sendsms","metadata":{"seo":{"title":"Send SMS","description":"Sends an SMS message using the required sender ID, recipient and text fields and optionally include callback and reference ID fields.<br><br><b>Authentication options:</b> either use a <b>Promotexter token</b> in the Authorization header, or provide apiKey and apiSecret in the request body. Refer to the <a href=\"https://promotexter-api.redocly.app/api/api-authentication\" target=\"_blank\" rel=\"noopener noreferrer\">API Authentication</a> section for details.<br><br>"}},"httpPath":"/sms/send"},{"label":"Retrieve SMS","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/sms-messaging/retrievesmstransactions","routeSlug":"/api/sms-messaging/retrievesmstransactions","metadata":{"seo":{"title":"Retrieve SMS","description":"Retrieves SMS transactions via a single API call with pagination, sorting, and filter support.<br><br><b>Authentication options:</b> either send a <b>Promotexter token</b> in the Authorization header, or provide apiKey and apiSecret as query parameters. Refer to the <a href=\"https://promotexter-api.redocly.app/api/api-authentication\" target=\"_blank\" rel=\"noopener noreferrer\">API Authentication</a> section for details.<br><br>"}},"httpPath":"/api/sms"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Receive Inbound Messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api/sms-messaging/receivesmsinboundmessageswebhook","routeSlug":"/api/sms-messaging/receivesmsinboundmessageswebhook","metadata":{"seo":{"title":"Receive Inbound Messages","description":"Receive inbound SMS messages through your configured webhook URL in real-time (via GET method). <br><br> To provision an Access code or Virtual reply number (VRN), reach out to your Account Manager at sales@promotexter.com. If your integration requires POST method, contact support@promotexter.com.<br><br>"}},"httpPath":"/your/sms/webhook/path"}]},{"type":"group","label":"Email Messaging","link":"/api/email-messaging","routeSlug":"/api/email-messaging","items":[{"label":"Send email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/email-messaging/sendemail","routeSlug":"/api/email-messaging/sendemail","metadata":{"seo":{"title":"Send email","description":"Sends an email message using the required from email, recipient, email subject, email body, and html setting, and optionally include file attachment, callback and group name fields.<br><br><b>Authentication options:</b> either use a <b>Promotexter token</b> in the Authorization header, or provide apiKey and apiSecret in the request body. Refer to the <a href=\"https://promotexter-api.redocly.app/api/api-authentication\" target=\"_blank\" rel=\"noopener noreferrer\">API Authentication</a> section for details.<br><br>"}},"httpPath":"/email"}]},{"type":"separator","label":"Business Calls"},{"type":"group","label":"Viber Business Calls","link":"/api/viber-business-calls","routeSlug":"/api/viber-business-calls","items":[]},{"type":"separator","label":"Authentication Services"},{"type":"group","label":"SMS Verify","link":"/api/sms-verify","routeSlug":"/api/sms-verify","items":[{"label":"Generate and send verification code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/sms-verify/generatetwofactorcode","routeSlug":"/api/sms-verify/generatetwofactorcode","metadata":{"seo":{"title":"Generate and send verification code","description":"Generates a one-time verification code and sends it via SMS using the required sender ID, recipient and text fields, and optionally include code format customization, expiration, attemptLimit, callback and reference ID fields.<br><br><b>Authentication options:</b> either use a <b>Promotexter token</b> in the Authorization header, or provide apiKey and apiSecret in the request body. Refer to the <a href=\"https://promotexter-api.redocly.app/api/api-authentication\" target=\"_blank\" rel=\"noopener noreferrer\">API Authentication</a> section for details.<br><br>"}},"httpPath":"/twofa/generate"},{"label":"Verify generated code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/sms-verify/verifytwofactorcode","routeSlug":"/api/sms-verify/verifytwofactorcode","metadata":{"seo":{"title":"Verify generated code","description":"Verifies the generated one-time verification code using the required id and code fields.<br><br><b>Authentication options:</b> either use a <b>Promotexter token</b> in the Authorization header, or provide apiKey and apiSecret in the request body. Refer to the <a href=\"https://promotexter-api.redocly.app/api/api-authentication\" target=\"_blank\" rel=\"noopener noreferrer\">API Authentication</a> section for details.<br><br>"}},"httpPath":"/twofa/verify"}]},{"type":"group","label":"Viber Verification Messages","link":"/api/viber-verification-messages","routeSlug":"/api/viber-verification-messages","items":[{"label":"Send Viber verification messages","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/viber-verification-messages/sendviberverification","routeSlug":"/api/viber-verification-messages/sendviberverification","metadata":{"seo":{"title":"Send Viber verification messages","description":"Send a pre-approved Viber verification message template by choosing a template below and by using the required Viber channel ID, recipient, and template fields, and optionally including SMS fallback, ttl, callback, and reference ID fields.<br><br><b>Authentication options:</b> either use a <b>Promotexter token</b> in the Authorization header, or provide apiKey and apiSecret in the request body. Refer to the <a href=\"https://promotexter-api.redocly.app/api/api-authentication\" target=\"_blank\" rel=\"noopener noreferrer\">API Authentication</a> section for details.<br><br>"}},"httpPath":"/viber/send‌"}]},{"type":"group","label":"WhatsApp Authentication","link":"/api/whatsapp-authentication","routeSlug":"/api/whatsapp-authentication","items":[{"label":"Send WhatsApp authentication messages","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/whatsapp-authentication/sendwhatsappauthentication","routeSlug":"/api/whatsapp-authentication/sendwhatsappauthentication","metadata":{"seo":{"title":"Send WhatsApp authentication messages","description":"Send a WhatsApp authentication template message using Meta-compatible payload structure and optionally enables SMS fallback when WhatsApp delivery fails. WhatsApp template content is not automatically reused for SMS delivery, please define your SMS fallback message wording per request.<br><br><blockquote><p><b>Note:</b> The below WhatsApp error codes will trigger SMS fallback when the required SMS fallback parameters are included in the request.</p><ol><li><code>131026</code> - Unable to deliver message. Reasons can include the recipient not being a WhatsApp user, not having accepted the latest Terms of Service and Privacy Policy, or using an outdated WhatsApp version.</li><li><code>131062</code> - Business-scoped User ID (BSUID) recipients are not supported for this message.</li></ol><p>See <a href=\"https://developers.facebook.com/documentation/business-messaging/whatsapp/support/error-codes\" target=\"_blank\" rel=\"noopener noreferrer\">WhatsApp error codes</a>.</p></blockquote><br><b>Authentication options:</b> either use a <b>Promotexter token</b> in the Authorization header, or provide apiKey and apiSecret in the request body. Refer to the <a href=\"https://promotexter-api.redocly.app/api/api-authentication\" target=\"_blank\" rel=\"noopener noreferrer\">API Authentication</a> section for details.<br><br>"}},"httpPath":"/whatsapp/send‌"}]},{"type":"group","label":"Silent Network Authentication","link":"/api/silent-network-authentication","routeSlug":"/api/silent-network-authentication","items":[]},{"type":"separator","separatorLine":true},{"type":"separator","label":"References"},{"type":"link","fsPath":"statuscodes.md","metadata":{"type":"markdown"},"label":"Status Codes","link":"/statuscodes","routeSlug":"/statuscodes"},{"type":"link","fsPath":"errorcodes.md","metadata":{"type":"markdown"},"label":"Error Codes","link":"/errorcodes","routeSlug":"/errorcodes"},{"type":"group","label":"Other Resources","items":[{"type":"link","fsPath":"viberlang.md","metadata":{"type":"markdown"},"label":"Viber Template Languages","link":"/viberlang","routeSlug":"/viberlang"},{"type":"link","fsPath":"clienttoken.md","metadata":{"type":"markdown"},"label":"Client Token Generation Guide","link":"/clienttoken","routeSlug":"/clienttoken"}]}]}