Authkey is a secure omnichannel platform offering a comprehensive suite of services, including SMS OTPs, transactional messages, promotional bulk SMS, WhatsApp Business messaging, Voice IVR, Email, and RCS messaging. Built to empower developers and businesses, our platform ensures high performance, reliability, and seamless communication across multiple channels.
\nBy integrating Authkey’s omnichannel API, businesses can:
\nDeliver consistent communication across SMS, WhatsApp, Voice, Email, and RCS channels.
\nCreate unified customer experiences with personalised interactions on their preferred channel.
\nMonitor and optimize campaigns through centralized analytics and reporting tools.
\nAuthkey ensures secure access through API key-based authentication. Every client is assigned a unique API Key to authenticate their account.
\nIP-Based Restrictions: Clients can limit API usage to specific IP addresses to enhance security.
\nCustom Encryption: Use the POST method; if encryption is required, we provide Base16 encoding or develop encryption according to specific needs.
\nData Masking: We offer options for data masking and secure downloads.
\nIf an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.
\nAuthkey stands out as a true omnichannel communication platform, enabling businesses to connect with customers via multiple channels:
\nSMS Messaging:
\nUse Cases: OTPs, transactional updates, and promotional campaigns.
\nKey Features: High delivery rates, real-time reporting, and bulk campaign support.
\nWhatsApp Business Messaging:
\nUse Cases: Customer support, notifications, promotional campaigns, and chat automation.
\nKey Features:
\nPersonalized two-way communication.
\nMulti-Agent Support.
\nDrag-and-Drop Chatbot Flow.
\nQuick template approval for message delivery.
\nWebsite WhatsApp Chat Widget.
\nClick-to-Ads Support.
\nVoice IVR Services:
\nUse Cases: Interactive customer support, automated call routing, and survey collection.
\nKey Features:
\nEasy-to-configure IVR flows.
\nDirect API with TTS support.
\nHigh-quality audio delivery.
\nMulti-level IVR support for complex call handling.
\nEmail Messaging:
\nUse Cases: Transactional emails, newsletters, and marketing campaigns.
\nKey Features:
\nHigh deliverability and advanced spam filtering.
\nDetailed analytics for email performance.
\nRCS Messaging (Rich Communication Services):
\nUse Cases: Interactive and media-rich customer interactions.
\nKey Features:
\nSupport for images, carousels, and call-to-action buttons.
\nBranded messaging for an enhanced customer experience.
\nReal-time delivery tracking and analytics.
\nSMS as fallback to ensure a 100% delivery rate.
\nAuthkey.io is built for enterprise-grade performance, ensuring reliability and scalability for businesses of all sizes.
\nDefault Performance:
\nRate Limit:
\nSMS: 5,000 TPS
\nVoice: 500 TPS
\nWhatsApp: 1,000 TPS (depending on account sending limits)
\nEmail: 500 TPS
\nThroughput: Supports up to 20,000 requests per second under standard configurations.
\nResponse Times: Average response time ranges from 100 ms to 400 ms.
\nEnhanced Scalability with High-Performance Clusters:
\nThroughput: Capable of processing up to 5,000 transactions per second (TPS).
\nResponse Times: Average response time ranges from 50 ms to 120 ms.
\nFor custom scalability requirements, contact hello@authkey.io.
\nAt Authkey, safeguarding customer data is our top priority. Our security practices ensure that data is securely transmitted, stored, and processed in compliance with global standards.
\nCloud Hosting Environment: All endpoints are hosted on a serverless infrastructure for high availability.
\nSSL/TLS Encryption: End-to-end encryption ensures secure communication.
\nWeb Application Firewall (WAF): Protects API endpoints against unauthorized access.
\nIP-Based Restrictions: Enable strict control over API access.
\nAuthkey ensures secure data retention and disposal to meet regulatory requirements:
\nBanking Clients: Data is retained for 1 year as per regulations.
\nOther Clients: Data is retained for 2 months and then archived securely.
\nAccessing logs requires multi-factor authentication:
\nLog in using your credentials.
\nComplete OTP verification sent to your registered mobile number.
\nAccount Owners: Full access to logs.
\nSupport Team: Limited access for resolving issues.
\nThird Parties: No access is granted to external entities.
\nFor more information about Authkey.io’s services, security measures, or integration support, contact us:
\nEmail: hello@authkey.io
\nWebsite: www.authkey.io
\nBefore proceeding, ensure you have:
\nA valid phone number.
\nA valid email ID.
\nVisit the Authkey signup page.
\nEnter your details:
\nName
\nEmail ID
\nPhone Number
\nCreate a secure password for your account.
\nVerify your email and phone number via OTPs sent to the respective channels.
\nEnjoy free benefits upon successful signup:
\nReceive 2,500 free credits to test and integrate our services.
\nGet free WhatsApp Business onboarding.
\nEnjoy 1,000 free WhatsApp Business conversations.
\nClick Here for Signup!
\n","_postman_id":"3b915d8b-4c1a-42c5-8c2a-79920234adc1"}],"id":"beb8a0be-60d1-4a9b-94d1-85116ebe961a","description":"To get start using Authkey. Just follow below steps.
\n","_postman_id":"beb8a0be-60d1-4a9b-94d1-85116ebe961a"},{"name":"OTP/2FA","item":[{"name":"Via SMS","item":[{"name":"Send 2fa via SID","event":[{"listen":"test","script":{"id":"92065d9e-c59c-48a6-b813-f221c2e928e8","exec":[""],"type":"text/javascript","packages":{}}}],"id":"d46a3b6a-06e8-452d-b56d-d7526c2c684c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.authkey.io/request?authkey=AUTHKEY&mobile=RecepientMobile&country_code=CountryCode&sid=1001","urlObject":{"protocol":"https","path":["request"],"host":["api","authkey","io"],"query":[{"description":{"content":"Your account Authkey from the Authkey dashboard
\n","type":"text/plain"},"key":"authkey","value":"AUTHKEY"},{"description":{"content":"Recipient’s mobile number without “+” sign
\n","type":"text/plain"},"key":"mobile","value":"RecepientMobile"},{"description":{"content":"Recipient’s country dialing code (e.g., 91 for India)
\n","type":"text/plain"},"key":"country_code","value":"CountryCode"},{"description":{"content":"Template ID for SMS channel (must include {#2fa#} variable)
\n","type":"text/plain"},"key":"sid","value":"1001"}],"variable":[]}},"response":[{"id":"078480f3-2e2b-4243-bbbf-dc92aa7427b4","name":"2fa","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.authkey.io/request?authkey=Authkey&mobile=Recipient Mobile&country_code=Country Code&sid=xxxx","protocol":"https","host":["api","authkey","io"],"path":["request"],"query":[{"key":"authkey","value":"Authkey","description":"Obtain from authkey dashboard"},{"key":"mobile","value":"Recipient Mobile","description":"Recipient Mobile number on which the message sent"},{"key":"country_code","value":"Country Code","description":"County Code of User"},{"key":"sid","value":"xxxx","description":"Whenever any template is approved in the authkey account it generate SID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 06 Jan 2025 10:19:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"600"}],"cookie":[],"responseTime":null,"body":"{\n \"LogID\": \"02949c7eef02e4e093122c9635d5b4aa\",\n \"Message\": \"Submitted Successfully\"\n}"}],"_postman_id":"d46a3b6a-06e8-452d-b56d-d7526c2c684c"},{"name":"Verify 2fa OTP","id":"97a1b2af-b9fa-4789-b22f-2678e6a0866e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://authkey.io/api/2fa_verify.php?authkey=AUTHKEY&channel=sms&otp=xxxxx&logid=Log id","description":"To validate the OTP entered by the end user, utilize the VERIFY OTP API endpoint. This ensures that the provided OTP matches the one generated, maintaining security and accuracy.
\nThese endpoints are built to optimise your authentication workflows, offering secure, reliable, and efficient OTP handling.
\nNote: OTPs generated using Authkey's 2FA have an expiration time of 5 minutes. If you attempt to verify the OTP after this period, the status will display \"OTP expired.\"
\n","urlObject":{"protocol":"https","path":["api","2fa_verify.php"],"host":["authkey","io"],"query":[{"description":{"content":"Obtain from authkey dashboard
\n","type":"text/plain"},"key":"authkey","value":"AUTHKEY"},{"description":{"content":"Select the Channel by which OTP send
\n","type":"text/plain"},"key":"channel","value":"sms"},{"description":{"content":"Enter the OTP enter by the user
\n","type":"text/plain"},"key":"otp","value":"xxxxx"},{"description":{"content":"Pass the log ID generated during the previous OTP API testing here.
\n","type":"text/plain"},"key":"logid","value":"Log id"}],"variable":[]}},"response":[{"id":"2af6c2bf-b0dd-471a-be02-a0a67ebfe9c0","name":"Verify 2fa","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://authkey.io/api/2fa_verify.php?authkey=AUTHKEY&channel=sms&otp=xxxxxx&logid=Log Id","protocol":"https","host":["authkey","io"],"path":["api","2fa_verify.php"],"query":[{"key":"authkey","value":"AUTHKEY","description":"Obtain from authkey dashboard"},{"key":"channel","value":"sms","description":"Select the Channel by which OTP send"},{"key":"otp","value":"xxxxxx","description":"Enter the OTP enter by the user "},{"key":"logid","value":"Log Id","description":"\nPass the log ID generated during the previous OTP API testing here."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.24.0 (Ubuntu)"},{"key":"Date","value":"Mon, 06 Jan 2025 10:59:11 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"600"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"Valid OTP\"\n}"}],"_postman_id":"97a1b2af-b9fa-4789-b22f-2678e6a0866e"}],"id":"35de057c-99b0-40cd-897a-05f3b4fc144e","description":"Description:
\nTo send 2FA via SMS, you must first get your template approved on the DLT platform with a variable placeholder. Once approved, create the same template in Authkey by replacing that variable with {#2fa#}.
\nThis API sends a system-generated OTP to the recipient via SMS using a pre-approved template on the Authkey platform.
Ensure that the SMS template includes the {#2fa#} variable, which will be dynamically replaced with the generated OTP at the time of sending.
Your account Authkey from the Authkey dashboard
\n","type":"text/plain"},"key":"authkey","value":"Recipient’s mobile number without “+” sign
\n","type":"text/plain"},"key":"mobile","value":"Recepient_mobile"},{"description":{"content":"Recipient’s country dialing code (e.g., 91 for India)
\n","type":"text/plain"},"key":"country_code","value":"recipient_country"},{"description":{"content":"Template ID for WhatsApp channel (must include {#2fa#} variable)
\n","type":"text/plain"},"key":"wid","value":"Template_ID"}],"variable":[]}},"response":[],"_postman_id":"f8ae1b9a-0d72-45d8-abbe-73aacae7b357"},{"name":"2fa verification","id":"89643a4d-7b19-4aba-9662-f4952a0b3d39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://console.authkey.io/api/2fa_verify.php?authkey=AUTHKEY&channel=whatsapp&otp=User_OTP&logid=Response_of_send_otp","description":"Description:
\nVerifies that the OTP entered by the user matches the one sent via WhatsApp.
\nOTPs expire in 5 minutes for security purposes.
\nParameters:
\nauthkey — Your account Authkey from the Authkey dashboard
channel — whatsapp
otp — OTP value entered by the user
logid — Log ID returned in the Send OTP API response
Your account Authkey from the Authkey dashboard
\n","type":"text/plain"},"key":"authkey","value":"AUTHKEY"},{"description":{"content":"OTP VALUE ENTERED BY CUSTOMER
\n","type":"text/plain"},"key":"otp","value":"User_OTP"},{"description":{"content":"Log ID returned in the Send OTP API response
\n","type":"text/plain"},"key":"logid","value":"Response_of_send_otp"}],"variable":[]}},"response":[{"id":"17a2442f-2e62-4a69-bec4-bb7761933910","name":"2fa verification","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://console.authkey.io/api/2fa_verify.php?authkey=a5c3489f99593dca&channel=whatsapp&otp=276049&logid=c414267ca8dc4d87ad794ebb5ff90382","protocol":"https","host":["console","authkey","io"],"path":["api","2fa_verify.php"],"query":[{"key":"authkey","value":"a5c3489f99593dca","description":"AUTHKEY"},{"key":"channel","value":"whatsapp","description":"SMS/VOICE/EMAIL/WHATSAPP"},{"key":"otp","value":"276049","description":"OTP VALUE ENTERED BY CUSTOMER"},{"key":"logid","value":"c414267ca8dc4d87ad794ebb5ff90382","description":"LogID GENERATED ON REQUEST API"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 25 Jul 2025 06:14:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"600"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self' https://login.maahirinfotech.com https://whatsapp.adznetworkmedia.om https://connect.adtrend.in https://console.steviadigital.com https://app.shinenetcore.in https://api.growithrms.com https://omni.serri.in https://waba.smsmenow.in https://bw.pertinaxsolutions.com https://waba.co3.live https://waba.messagewall.in https://whatsapp.kanenitech.com https://more.myprofunnels.com https://loginpanels.com https://whatsapp.filgy.com https://console.mmsworld.in https://wp.promotionkart.com https://api.dcoretec.com https://auth.promotionmantra.com https://cpaas.elevatexmarcom.com https://sureauth.inquisi.in;"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"Valid OTP\"\n}"}],"_postman_id":"89643a4d-7b19-4aba-9662-f4952a0b3d39"}],"id":"efc38980-a2d4-4748-b376-1441d067c0c0","description":"Description:
\nTo send a 2FA (Two-Factor Authentication) WID template, please contact your account manager to enable authentication access for your account. Once it’s activated, you can create the required template from your Authkey dashboard.
\nThis API sends a system-generated OTP to the recipient via WhatsApp using a pre-approved template.
\nEnsure that your WhatsApp template includes the variable {#2fa#}, which will be automatically replaced with the generated OTP during message delivery.
\n","_postman_id":"efc38980-a2d4-4748-b376-1441d067c0c0"},{"name":"Via Voice","item":[{"name":"Send OTP with 2FA","id":"ae111774-9ba0-4eff-9c2a-e1b4cdee385b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.authkey.io/request?authkey=Authkey&mobile=xxxxx&country_code=xx&vid=Template_ID","urlObject":{"protocol":"https","path":["request"],"host":["api","authkey","io"],"query":[{"description":{"content":"Your account Authkey from the Authkey dashboard
\n","type":"text/plain"},"key":"authkey","value":"Authkey"},{"description":{"content":"Recipient’s mobile number without “+” sign
\n","type":"text/plain"},"key":"mobile","value":"xxxxx"},{"description":{"content":"Recipient’s country dialing code (e.g., 91 for India)
\n","type":"text/plain"},"key":"country_code","value":"xx"},{"description":{"content":"Template ID for Voice channel (must include {#2fa#} variable)
\n","type":"text/plain"},"key":"vid","value":"Template_ID"}],"variable":[]}},"response":[{"id":"dcbac5f8-c745-4e26-bf70-1f673f15ce81","name":"Send OTP with 2FA Copy","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.authkey.io/request?authkey=a5c3489f99593dca&mobile=8882111717&country_code=91&wid=12154","protocol":"https","host":["api","authkey","io"],"path":["request"],"query":[{"key":"authkey","value":"a5c3489f99593dca"},{"key":"mobile","value":"8882111717"},{"key":"country_code","value":"91"},{"key":"wid","value":"12154","description":"The message template must have a variable {#2fa#} : A system generated OTP will be passed in a variable field."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 25 Jul 2025 06:12:43 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"access-control-allow-origin","value":"*"},{"key":"access-control-allow-headers","value":"Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token"},{"key":"access-control-allow-credentials","value":"true"},{"key":"Apigw-Requestid","value":"OQH-Uhv5hcwEMNQ="}],"cookie":[],"responseTime":null,"body":"{\n \"LogID\": \"c414267ca8dc4d87ad794ebb5ff90382\",\n \"Message\": \"Submitted Successfully\"\n}"}],"_postman_id":"ae111774-9ba0-4eff-9c2a-e1b4cdee385b"},{"name":"2fa verification","id":"dc31ba08-a111-4422-a49f-cb58d560737d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://console.authkey.io/api/2fa_verify.php?authkey=AUTHKEY&channel=xxxx&otp=User_OTP&logid=Response_of_send_otp","description":"Description:
\nVerifies that the OTP entered by the user matches the one sent via Voice.
\nOTPs expire in 5 minutes for security purposes.
\n","urlObject":{"protocol":"https","path":["api","2fa_verify.php"],"host":["console","authkey","io"],"query":[{"description":{"content":"Your account Authkey from the Authkey dashboard
\n","type":"text/plain"},"key":"authkey","value":"AUTHKEY"},{"description":{"content":"voice
\n","type":"text/plain"},"key":"channel","value":"xxxx"},{"description":{"content":"OTP value entered by the user
\n","type":"text/plain"},"key":"otp","value":"User_OTP"},{"description":{"content":"Log ID returned in the Send OTP API response
\n","type":"text/plain"},"key":"logid","value":"Response_of_send_otp"}],"variable":[]}},"response":[{"id":"af343007-ad20-4467-adda-93fae65f9689","name":"2fa verification","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://console.authkey.io/api/2fa_verify.php?authkey=a5c3489f99593dca&channel=whatsapp&otp=276049&logid=c414267ca8dc4d87ad794ebb5ff90382","protocol":"https","host":["console","authkey","io"],"path":["api","2fa_verify.php"],"query":[{"key":"authkey","value":"a5c3489f99593dca","description":"AUTHKEY"},{"key":"channel","value":"whatsapp","description":"SMS/VOICE/EMAIL/WHATSAPP"},{"key":"otp","value":"276049","description":"OTP VALUE ENTERED BY CUSTOMER"},{"key":"logid","value":"c414267ca8dc4d87ad794ebb5ff90382","description":"LogID GENERATED ON REQUEST API"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 25 Jul 2025 06:14:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"600"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self' https://login.maahirinfotech.com https://whatsapp.adznetworkmedia.om https://connect.adtrend.in https://console.steviadigital.com https://app.shinenetcore.in https://api.growithrms.com https://omni.serri.in https://waba.smsmenow.in https://bw.pertinaxsolutions.com https://waba.co3.live https://waba.messagewall.in https://whatsapp.kanenitech.com https://more.myprofunnels.com https://loginpanels.com https://whatsapp.filgy.com https://console.mmsworld.in https://wp.promotionkart.com https://api.dcoretec.com https://auth.promotionmantra.com https://cpaas.elevatexmarcom.com https://sureauth.inquisi.in;"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"Valid OTP\"\n}"}],"_postman_id":"dc31ba08-a111-4422-a49f-cb58d560737d"}],"id":"3dc15bf1-645f-43be-b31f-8b6168a58310","description":"Description:
\nSends a system-generated OTP to the recipient via a voice call using a pre-approved voice template.
\nThe template must include the {#2fa#} variable, which will be replaced with the generated OTP during the call.
Sends a system-generated OTP to the recipient via email using a pre-approved email template.
\nThe email template must include the {#2fa#} variable, which will be replaced with the generated OTP.
Your account Authkey from the Authkey dashboard
\n","type":"text/plain"},"key":"authkey","value":"Authkey"},{"description":{"content":"Your account Authkey from the Authkey dashboardRecipient’s email address
\n","type":"text/plain"},"key":"email","value":"Recepient_email"},{"description":{"content":"Template ID for Email channel (must include {#2fa#} variable)
\n","type":"text/plain"},"key":"mid","value":"Template_ID"}],"variable":[]}},"response":[{"id":"e8105d57-9992-4e47-8188-1cf574fc004b","name":"Send OTP with 2FA Copy","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.authkey.io/request?authkey=a5c3489f99593dca&mobile=8882111717&country_code=91&wid=12154","protocol":"https","host":["api","authkey","io"],"path":["request"],"query":[{"key":"authkey","value":"a5c3489f99593dca"},{"key":"mobile","value":"8882111717"},{"key":"country_code","value":"91"},{"key":"wid","value":"12154","description":"The message template must have a variable {#2fa#} : A system generated OTP will be passed in a variable field."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 25 Jul 2025 06:12:43 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"access-control-allow-origin","value":"*"},{"key":"access-control-allow-headers","value":"Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token"},{"key":"access-control-allow-credentials","value":"true"},{"key":"Apigw-Requestid","value":"OQH-Uhv5hcwEMNQ="}],"cookie":[],"responseTime":null,"body":"{\n \"LogID\": \"c414267ca8dc4d87ad794ebb5ff90382\",\n \"Message\": \"Submitted Successfully\"\n}"}],"_postman_id":"55dc6c07-1608-47b0-93d5-9cd290e658d2"},{"name":"2fa verification","id":"92987b57-340d-462d-9441-68a170cd004a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://console.authkey.io/api/2fa_verify.php?authkey=AUTHKEY&channel=xxxx&otp=User_OTP&logid=Response_of_send_otp","description":"Description:
\nVerifies that the OTP entered by the user matches the one sent via Email.
\nOTPs expire in 5 minutes for security purposes.
\n","urlObject":{"protocol":"https","path":["api","2fa_verify.php"],"host":["console","authkey","io"],"query":[{"description":{"content":"Your account Authkey from the Authkey dashboard
\n","type":"text/plain"},"key":"authkey","value":"AUTHKEY"},{"description":{"content":"OTP value entered by the user
\n","type":"text/plain"},"key":"otp","value":"User_OTP"},{"description":{"content":"Log ID returned in the Send OTP API response
\n","type":"text/plain"},"key":"logid","value":"Response_of_send_otp"}],"variable":[]}},"response":[{"id":"c106ecf3-f378-4caf-8a98-ca90422c4417","name":"2fa verification","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://console.authkey.io/api/2fa_verify.php?authkey=a5c3489f99593dca&channel=whatsapp&otp=276049&logid=c414267ca8dc4d87ad794ebb5ff90382","protocol":"https","host":["console","authkey","io"],"path":["api","2fa_verify.php"],"query":[{"key":"authkey","value":"a5c3489f99593dca","description":"AUTHKEY"},{"key":"channel","value":"whatsapp","description":"SMS/VOICE/EMAIL/WHATSAPP"},{"key":"otp","value":"276049","description":"OTP VALUE ENTERED BY CUSTOMER"},{"key":"logid","value":"c414267ca8dc4d87ad794ebb5ff90382","description":"LogID GENERATED ON REQUEST API"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 25 Jul 2025 06:14:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"600"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self' https://login.maahirinfotech.com https://whatsapp.adznetworkmedia.om https://connect.adtrend.in https://console.steviadigital.com https://app.shinenetcore.in https://api.growithrms.com https://omni.serri.in https://waba.smsmenow.in https://bw.pertinaxsolutions.com https://waba.co3.live https://waba.messagewall.in https://whatsapp.kanenitech.com https://more.myprofunnels.com https://loginpanels.com https://whatsapp.filgy.com https://console.mmsworld.in https://wp.promotionkart.com https://api.dcoretec.com https://auth.promotionmantra.com https://cpaas.elevatexmarcom.com https://sureauth.inquisi.in;"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"Valid OTP\"\n}"}],"_postman_id":"92987b57-340d-462d-9441-68a170cd004a"}],"id":"15a486d4-9ea1-4097-98e7-8e89661252b2","description":"Description:
\nSends a system-generated OTP to the recipient via email using a pre-approved email template.
\nThe email template must include the {#2fa#} variable, which will be replaced with the generated OTP.
Obtain from the Profile section
\n","type":"text/plain"},"key":"authkey","value":"AUTHKEY"},{"description":{"content":"User Mobile Number
\n","type":"text/plain"},"key":"mobile","value":"Recipient number"},{"description":{"content":"User country code
\n","type":"text/plain"},"key":"country_code","value":"Country code"},{"description":{"content":"Testing Message Content
\n","type":"text/plain"},"key":"sid","value":"SMS_Template_id"},{"description":{"content":"Testing Voice Message Content
\n","type":"text/plain"},"key":"fb1vid","value":"Voice_template_id"}],"variable":[]}},"response":[{"id":"6ca977aa-cccd-4b6d-9dcb-e766e4f52b9d","name":"Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.authkey.io/request?authkey=AUTHKEY&mobile=Recipient number&country_code=country code&sms=Hello, your OTP is 1234&fb1voice=Hello, your otp is 1234&sender=Approved Header ID","protocol":"https","host":["api","authkey","io"],"path":["request"],"query":[{"key":"authkey","value":"AUTHKEY","description":"Obtain from the Profile section"},{"key":"mobile","value":"Recipient number","description":"User Mobile Number "},{"key":"country_code","value":"country code","description":"User country code"},{"key":"sms","value":"Hello, your OTP is 1234","description":"Testing Message Content"},{"key":"fb1voice","value":"Hello, your otp is 1234","description":"Testing Voice Message Content"},{"key":"sender","value":"Approved Header ID","description":"The sender ID is your Header ID that get from DLT platform"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 15 Jan 2025 12:21:39 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"access-control-allow-origin","value":"*"},{"key":"access-control-allow-headers","value":"Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token"},{"key":"access-control-allow-credentials","value":"true"},{"key":"Apigw-Requestid","value":"Ebc9AiVvhcwEMfA="}],"cookie":[],"responseTime":null,"body":"{\n \"LogID\": \"abb1a004d526413f96b40748edde0d94\",\n \"Message\": \"Submitted Successfully\"\n}"}],"_postman_id":"d8b323e0-ac83-41ba-9843-b645885885c5"}],"id":"c583da7a-958d-4ff7-a40e-17fbe2111837","description":"The Authkey Fallback API is designed to maximize your message delivery rates by intelligently switching between channels when the primary one fails. With this feature, you can set a primary channel simply by using a channel template (e.g., sid, wid, mid, vid).
Once the primary channel is defined, you can configure multiple fallback channels in order of preference by assigning their respective channel template IDs, such as:
\n&fb1=Channel_Template_ID
&fb2=Channel_Template_ID
and so on.
\nThis ensures that if the primary channel cannot deliver the message, the system will automatically attempt delivery through the next available channel — giving you higher reach, better reliability, and improved campaign performance.
\n","_postman_id":"c583da7a-958d-4ff7-a40e-17fbe2111837"},{"name":"Parallel","item":[{"name":"Parallel Sending","id":"fd88dd01-85b1-464f-9844-3891a39d5e8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.authkey.io/request?authkey=Authkey&mobile=recipent_number&country_code=xx&sid=xxxx&mid=xx&vid=xx&wid=xx&email=xx","urlObject":{"protocol":"https","path":["request"],"host":["api","authkey","io"],"query":[{"key":"authkey","value":"Authkey"},{"key":"mobile","value":"recipent_number"},{"key":"country_code","value":"xx"},{"key":"sid","value":"xxxx"},{"key":"mid","value":"xx"},{"key":"vid","value":"xx"},{"key":"wid","value":"xx"},{"key":"email","value":"xx"}],"variable":[]}},"response":[],"_postman_id":"fd88dd01-85b1-464f-9844-3891a39d5e8d"}],"id":"a8419b72-b35e-4b03-8581-b9ef0d096fa9","description":"Description:
\nThe Parallel API allows you to send a message simultaneously through multiple channels (SMS, WhatsApp, Email, and Voice).
\nThis ensures the recipient receives the message instantly on any of their available channels, without waiting for fallback attempts.
\nKey Notes:
\nAll channel parameters (sid, wid, mid, vid) are optional; include only those you want to send in parallel.
Each channel must have a pre-approved template in the Authkey platform.
\nFor Email, ensure that the email parameter is included along with mid.
To send SMS via Authkey, ensure the following details are ready:
\nRegistration with a Distributed Ledger Technology (DLT) platform is mandatory.
\nObtain your Entity ID, a unique ID shown under your DLT profile.
\nA unique, 6-character identifier representing your company or brand name.
\nExamples: MYBRND, IPAYTM, AXISTM.
\nAfter December 2024, TRAI mandates users to connect their Chain ID with their operator.
\nUpon logging into the respective DLT portal, select Datagen Internet Services Private Limited as your TD partner. The name will auto-populate; our TD ID is 110200001253.
\nObtain from Registered Profile
\n","type":"text/plain"},"key":"authkey","value":"AUTHKEY"},{"description":{"content":"User phone number
\n","type":"text/plain"},"key":"mobile","value":"RecepientMobile"},{"description":{"content":"User country code
\n","type":"text/plain"},"key":"country_code","value":"CountryCode"},{"description":{"content":"Otp approved SMS template ID
\n","type":"text/plain"},"key":"sid","value":"xxxx"},{"description":{"content":"If your template includes any variables, add them here using key = variable name as defined in the template, and in the value, provide the parameter you wish to send.
\n","type":"text/plain"},"key":"var_name","value":"Parameter"}],"variable":[]}},"response":[{"id":"d59162d4-d140-4508-8d50-2fbb197c474f","name":"Send OTP via Copy","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.authkey.io/request?authkey=Authkey&mobile=Recipient Mobile&country_code=Country Code&sid=xxxx","protocol":"https","host":["api","authkey","io"],"path":["request"],"query":[{"key":"authkey","value":"Authkey","description":"Obtain from authkey dashboard"},{"key":"mobile","value":"Recipient Mobile","description":"Recipient Mobile number on which the message sent"},{"key":"country_code","value":"Country Code","description":"County Code of User"},{"key":"sid","value":"xxxx","description":"Whenever any template is approved in the authkey account it generate SID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 06 Jan 2025 10:19:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"600"}],"cookie":[],"responseTime":null,"body":"{\n \"LogID\": \"02949c7eef02e4e093122c9635d5b4aa\",\n \"Message\": \"Submitted Successfully\"\n}"}],"_postman_id":"12c159cc-35ea-481a-9312-016c3e9aa99b"}],"id":"308e67a2-d5a1-4405-b66b-a56b633a2ada","description":"The following endpoints are designed for seamless OTP management, where Authkey.io automatically generates a random OTP and delivers it to the end user.
\nUse the provided API endpoint to send a system-generated random OTP directly to the end user. This eliminates the need for manual OTP generation and simplifies the process.
\nDLT Approval:
\n#var# placeholders.Authkey Platform Configuration:
\nReplicate the same template on the Authkey platform.
\nReplace the occurrence of one #var# with your OTP variable in the template. This step is critical to enable dynamic OTP functionality.
Template SID:
\nBy following these steps, you can ensure that your dynamic OTP message templates function seamlessly across platforms.
\n","_postman_id":"308e67a2-d5a1-4405-b66b-a56b633a2ada"},{"name":"Bulk SMS","item":[{"name":"Bulk SMS","id":"0b230b1f-f548-488f-a42d-d4e3b3ee5e49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"version\": \"1.0\",\n \"authkey\": \"Account_authkey\",\n \"encrpt\": \"0\",\n \"pe_id\": \"Entity_id\",\n \"template_id\": \"DLT_template_id\",\n \"country_code\": \"91\",\n \"is_unicode\": 0,\n \"sender\": \"Header/Sender_id\",\n \"messages\": [\n {\n \"dest\": [\n \"Customer1_number\",\"customer2_number\"\n ],\n \"text\": \"Text message content\",\n \"param\": {\n \"var1\": \"value\", //Parmeter define if created in message template \n \"var3\": \"value\"\n }\n } ]\n}","options":{"raw":{"language":"json"}}},"url":"https://console.authkey.io/restapi/bulksms_json.php","urlObject":{"protocol":"https","path":["restapi","bulksms_json.php"],"host":["console","authkey","io"],"query":[],"variable":[]}},"response":[{"id":"b4b1ccf7-8e3a-4f17-86c4-d61db397d976","name":"Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"version\":\"1.0\",\n\"authkey\":\"523912703d2967f9\",\n\"encrpt\":\"0\",\n\"template_id\":\"11367\",\n\"country_code\":\"91\",\n\"is_unicode\":0,\n\"sender\":\"AUTHKY\",\n\"biz_extra\":\"XXXXXX\",\n\"messages\":[{\"dest\":[\"8882111717\",\"6393699599\"],\"param\":{\"name\":\"suraj\",\"company\":\"datagen\"}}]\n}","options":{"raw":{"language":"json"}}},"url":"https://console.authkey.io/restapi/bulkrcs_json.php"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 17 Apr 2025 11:39:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"600"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"code\": 200,\n \"LogID\": \"2048e9155bfe43a26822317d06084881\",\n \"Message\": \"Submitted Successfully\"\n}"}],"_postman_id":"0b230b1f-f548-488f-a42d-d4e3b3ee5e49"}],"id":"46f3f54b-a109-4fc6-aced-cec98971df21","description":"Description:
\nThe Bulk SMS API allows you to send large-scale SMS campaigns to multiple recipients in a single request.
\nMessages are sent using pre-approved DLT templates (for India) or standard templates for international delivery.
\nYou can personalize each message by passing variable values per recipient.
\n","_postman_id":"46f3f54b-a109-4fc6-aced-cec98971df21"}],"id":"fa6f4251-d749-414e-85df-b0741057f918","description":"Description:
\nThe Send SMS API delivers messages using pre-approved SMS templates on the Authkey platform.
\nYou can send personalized messages by passing variable values in the request.
\nFully compliant with DLT regulations for India, with international delivery support.
\n","_postman_id":"fa6f4251-d749-414e-85df-b0741057f918"},{"name":"Send WhatsApp","item":[{"name":"Send Text Template","item":[{"name":"Send Simple WhatsApp","id":"4e2c1427-16ce-4fb7-b0b8-5d665b178eb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Basic=Your authkey portal authkey
\n"}],"body":{"mode":"raw","raw":" {\r\n \"country_code\": \"91\",\r\n \"mobile\": \"xxxx\",\r\n \"wid\": \"150\",\r\n \"type\": \"text\",\r\n \"bodyValues\": {\"1\":\"1234\"} \r\n \r\n}"},"url":"https://console.authkey.io/restapi/requestjson.php","description":"json reciever
\n","urlObject":{"protocol":"https","path":["restapi","requestjson.php"],"host":["console","authkey","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"2d8ad57b-48d6-4879-955f-231ed2845419"},{"name":"sendMediaWithoutVariable","id":"27c4ba2b-5767-43fd-81b2-173f9209b9d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic=Your authkey portal authkey
\n"}],"body":{"mode":"raw","raw":" {\r\n \"country_code\": \"91\",\r\n \"mobile\": \"xxxx\",\r\n \"wid\": \"164\",\r\n \"type\": \"media\", \r\n \"headerValues\": {\r\n \"headerFileName\": \"Return Ticket\", \r\n \"headerData\": \"https://authkey.io/whatsapp/gallery/4498/6465dbbca4fb7.jpeg\" \r\n }\r\n}"},"url":"https://console.authkey.io/restapi/requestjson.php","description":"json reciever
\n","urlObject":{"protocol":"https","path":["restapi","requestjson.php"],"host":["console","authkey","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"27c4ba2b-5767-43fd-81b2-173f9209b9d3"},{"name":"sendMediaWithVariable","id":"231387b3-39d4-4f15-a1e1-b65199349acd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic=Your authkey portal authkey
\n"}],"body":{"mode":"raw","raw":" {\r\n \"country_code\": \"91\",\r\n \"mobile\": \"xxxxx\",\r\n \"wid\": \"169\",\r\n \"type\": \"media\", \r\n \"bodyValues\": {\"1\":\"ashish\",\"2\":\"2000\"},\r\n \"headerValues\": {\r\n \"headerFileName\": \"Tax Invoice\", \r\n \"headerData\": \"http://dms.zorder.in/Attachments/37AD-C0BD-18M1-BF1C-B168/WhatsApp/SLS0011FY240000003_20230428054856.pdf\" \r\n }\r\n}"},"url":"https://console.authkey.io/restapi/requestjson.php","description":"json reciever
\n","urlObject":{"protocol":"https","path":["restapi","requestjson.php"],"host":["console","authkey","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"231387b3-39d4-4f15-a1e1-b65199349acd"}],"id":"c020b9c1-148c-4545-b9c7-5a26cac6f4e5","description":"Description:
\nUse this API to send a text-based WhatsApp message using an approved template.
\nThis is ideal for sending appointment reminders, OTPs, order updates, payment confirmations, or any message with text-only content and dynamic variables.
\n","_postman_id":"c020b9c1-148c-4545-b9c7-5a26cac6f4e5"},{"name":"Send WhatsApp Media","item":[{"name":"Simple Multimedia WhatsApp","id":"8507fd98-4e58-4431-9b80-c969f9857ec7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Basic","type":"text"}],"body":{"mode":"raw","raw":" {\r\n \"country_code\": \"91\",\r\n \"mobile\": \"xxxxxxx\",\r\n \"wid\": \"256\", \r\n \"type\": \"media\", \r\n \"headerValues\": {\r\n \"headerFileName\": \"SD51785222-23.pdf\", \r\n \"headerData\": \"\" \r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://authkey.io/restapi/requestjson.php","urlObject":{"protocol":"https","path":["restapi","requestjson.php"],"host":["authkey","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"8507fd98-4e58-4431-9b80-c969f9857ec7"},{"name":"Media With Dynamic WhatsApp","id":"1e622797-92e9-4069-8f74-485b774c0f01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Basic","type":"text"}],"body":{"mode":"raw","raw":" {\r\n \"country_code\": \"91\",\r\n \"mobile\": \"xxxxxxx\",\r\n \"wid\": \"256\",\r\n \"type\": \"media\", \r\n \"bodyValues\": {\"1\":\"ashish\",\"2\":\"2000\"}, \r\n //parameters name and amount are defined within the message template.\r\n \"headerValues\": {\r\n \"headerFileName\": \"Tax Invoice\", \r\n \"headerData\": \"file full url\" \r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://authkey.io/restapi/requestjson.php","urlObject":{"protocol":"https","path":["restapi","requestjson.php"],"host":["authkey","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"1e622797-92e9-4069-8f74-485b774c0f01"}],"id":"f6ee0151-e4b5-4426-9a73-4ac145deee4e","description":"Sending WhatsApp messages through Authkey.io APIs is quick and straightforward. Simply use the API endpoints provided to send WhatsApp templates effortlessly. Authkey offers a range of features, including WhatsApp chatbots, catalogs, website widgets, an agent dashboard, and more.
\nA verified Facebook Page for your company.
\nA phone number that is:
\nIf you are already using WhatsApp Business API somewhere, you will need your WABA ID (WhatsApp Business Account ID).
\nBefore you can send WhatsApp messages through the Authkey API, ensure the following requirements are met:
\nWhatsApp Business Account (WABA)
\nYou must have an active WhatsApp Business Account connected to Authkey.
\nIf you don’t have one, create it via Facebook Business Manager and connect it in your Authkey dashboard.
\nPhone Number Registration
\nThe sending number must be registered under your WhatsApp Business Account.
\nThe number should be verified and linked to your WABA.
\nApproved WhatsApp Templates
\nWhatsApp requires that all outbound messages (outside the 24-hour session window) use pre-approved templates.
\nCreate your template in Authkey and submit it for WhatsApp approval.
\nThe template must match exactly when sending via API (including variables).
\nAuthkey Account Access
\nYou need an active Authkey account with WhatsApp API access enabled.
\nObtain your authkey from the Authkey dashboard.
Publicly Accessible Media Files (for media templates)
\nIf sending images, documents, or videos, ensure the file is hosted at a publicly accessible HTTPS URL.
\nWhatsApp will fetch the file directly from the provided URL.
\nVariable Mapping
\n{#var#}), you must pass them in the bodyValues or headerValues parameter exactly as defined in the template.Compliance with WhatsApp Policies
\nMessages must comply with WhatsApp Business & Meta’s commerce and messaging policies.
\nNo spam, prohibited products, or unsolicited promotional content outside the approved templates.
\n1:you need to send an auth key in the Authorization header, this is typically done to authenticate and authorize the request.
2:only text, video, image, document, and location messages are allowed to be sent.
\n3:for webhooks with POST or JSON requests is a powerful way to send and receive data between systems in real-time.
\n4:if you want to send an image, audio, video, or document via a URL, the link must be accessible and correctly formatted. If the URL opens in a browser and the file is available for download.
\n5:Allow Size Of Media
\n","_postman_id":"90a7d52d-45a4-4a5d-9740-b813cd76af4d"},{"name":"Send With Interactive Buttons","item":[{"name":"Text with buttons","id":"85a648c1-85e3-4c06-adcb-7b2fe6092e5a","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"key":"Authorization","value":"BasicPass account authkey here
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"mobile\": \"91xxxxxxxxx\",\n \"message_type\": \"send_interactive\",\n \"brand_number\": \"91xxxxxxxx\",\n \"message\": \"Type your message here which you want to send\",\n \"button_items\": [\n {\n \"id\": \"1\",\n \"title\": \"Button_label\"\n },\n {\n \"id\": \"2\",\n \"title\": \"Button_label\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://console.authkey.io/restapi/convjson.php","urlObject":{"protocol":"https","path":["restapi","convjson.php"],"host":["console","authkey","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"85a648c1-85e3-4c06-adcb-7b2fe6092e5a"},{"name":"Text with buttons/Header/footer","id":"09c80c81-350b-4e3d-bc8c-b5219f729eb0","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"key":"Authorization","value":"BasicPass account authkey here
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"mobile\": \"91xxxxxxxxx\",\n \"message_type\": \"send_interactive\",\n \"brand_number\": \"91xxxxxxxx\",\n \"message\": \"Type your message here which you want to send\",\n \"button_items\": [\n {\n \"id\": \"1\",\n \"title\": \"Button_label\"\n },\n {\n \"id\": \"2\",\n \"title\": \"Button_label\"\n }\n ],\n \"footer_text\": \"Type footer text here\",\n \"header_text\": {\n \"type\": \"text\", // for text type:text and text:test\n \"text\": \"Type Header text here\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://console.authkey.io/restapi/convjson.php","urlObject":{"protocol":"https","path":["restapi","convjson.php"],"host":["console","authkey","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"09c80c81-350b-4e3d-bc8c-b5219f729eb0"},{"name":"Image with buttons","id":"a466e716-e8f0-4b88-8e0f-238d53b7a39d","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"key":"Authorization","value":"BasicPass account authkey here
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"mobile\": \"91xxxxxxxxx\",\n \"message_type\": \"send_interactive\",\n \"brand_number\": \"91xxxxxxxx\",\n \"message\": \"Type your message here which you want to send\",\n \"button_items\": [\n {\n \"id\": \"1\",\n \"title\": \"Button_label\"\n },\n {\n \"id\": \"2\",\n \"title\": \"Button_label\"\n }\n ],\n \"footer_text\": \"Type footer text here\",\n \"header_text\": {\n \"type\": \"image\", // pass valid public image URL below\n \"image\": \"https://wpgallery.s3.ap-south-1.amazonaws.com/gallery/202508/689c58aba3945.png\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://console.authkey.io/restapi/convjson.php","urlObject":{"protocol":"https","path":["restapi","convjson.php"],"host":["console","authkey","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"a466e716-e8f0-4b88-8e0f-238d53b7a39d"},{"name":"Video with buttons","id":"333a28b4-6f3d-4436-8ae4-15d4bf4026b4","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"key":"Authorization","value":"BasicPass account authkey here
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"mobile\": \"91xxxxxxxxx\",\n \"message_type\": \"send_interactive\",\n \"brand_number\": \"91xxxxxxxx\",\n \"message\": \"Type your message here which you want to send\",\n \"button_items\": [\n {\n \"id\": \"1\",\n \"title\": \"Button_label\"\n },\n {\n \"id\": \"2\",\n \"title\": \"Button_label\"\n }\n ],\n \"footer_text\": \"Type footer text here\",\n \"header_text\": {\n \"type\": \"video\", // pass valid public video URL below.\n \"video\": \"https://wpgallery.s3.ap-south-1.amazonaws.com/gallery/202508/689c599bbc3a2.mp4\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://console.authkey.io/restapi/convjson.php","urlObject":{"protocol":"https","path":["restapi","convjson.php"],"host":["console","authkey","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"333a28b4-6f3d-4436-8ae4-15d4bf4026b4"},{"name":"Documents with buttons","id":"d79bf14d-339c-4aa4-9b24-191057bb0bad","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"key":"Authorization","value":"BasicPass account authkey here
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"mobile\": \"91xxxxxxxxx\",\n \"message_type\": \"send_interactive\",\n \"brand_number\": \"91xxxxxxxx\",\n \"message\": \"Type your message here which you want to send\",\n \"button_items\": [\n {\n \"id\": \"1\",\n \"title\": \"Button_label\"\n },\n {\n \"id\": \"2\",\n \"title\": \"Button_label\"\n }\n ],\n \"footer_text\": \"Type footer text here\",\n \"header_text\": {\n \"type\": \"document\", // pass valid public video URL below.\n \"document\": \"https://wpgallery.s3.ap-south-1.amazonaws.com/gallery/202508/68945fe22fb78.pdf\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://console.authkey.io/restapi/convjson.php","urlObject":{"protocol":"https","path":["restapi","convjson.php"],"host":["console","authkey","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"d79bf14d-339c-4aa4-9b24-191057bb0bad"},{"name":"Menu List","id":"8a347830-2587-401c-8eb0-147631a803a2","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"key":"Authorization","value":"BasicPass account authkey here
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"mobile\": \"91xxxxxxxxx\",\n \"message_type\": \"send_interactive\",\n \"brand_number\": \"91xxxxxxxx\",\n \"message\": \"Type your message here which you want to send\",\n \"menuitems\": [\n {\n \"id\": \"1\",\n \"title\": \"yes\"\n },\n {\n \"id\": \"2\",\n \"title\": \"no\"\n },\n {\n \"id\": \"3\",\n \"title\": \"call\"\n }\n ], //menu title will be 24 character max and item less than 10\n \"footer_text\": \"Type footer text here\",\n \"header_text\": {\n \"type\": \"text\", // pass valid public video URL below.\n \"document\": \"Header text\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://console.authkey.io/restapi/convjson.php","urlObject":{"protocol":"https","path":["restapi","convjson.php"],"host":["console","authkey","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"8a347830-2587-401c-8eb0-147631a803a2"},{"name":"CTA buttons","id":"fa915bcd-df01-465e-ab98-cd2e74870b35","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"key":"Authorization","value":"BasicPass account authkey here
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"mobile\": \"91xxxxxxxxx\",\n \"message_type\": \"send_interactive\",\n \"brand_number\": \"91xxxxxxxx\",\n \"message\": \"Type your message here which you want to send\",\n \"button_items\": {\n \"button_text\": \"visit\",\n \"button_url\": \"https://authkey.io\"\n },\n \"footer_text\": \"Type footer text here\",\n \"header_text\": {\n \"type\": \"text\", // for text type:text and text:test\n \"text\": \"Type Header text here\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://console.authkey.io/restapi/convjson.php","urlObject":{"protocol":"https","path":["restapi","convjson.php"],"host":["console","authkey","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"fa915bcd-df01-465e-ab98-cd2e74870b35"},{"name":"Image with CTA buttons","id":"33b86668-0799-42df-9d0a-5a765e50f0d1","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"key":"Authorization","value":"BasicPass account authkey here
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"mobile\": \"91xxxxxxxxx\",\n \"message_type\": \"send_interactive\",\n \"brand_number\": \"91xxxxxxxx\",\n \"message\": \"Type your message here which you want to send\",\n \"button_items\": {\n \"button_text\": \"visit\",\n \"button_url\": \"https://authkey.io\"\n },\n \"footer_text\": \"Type footer text here\",\n \"header_text\": {\n \"type\": \"image\", // for text type:text and text:test\n \"image\": \"https://wpgallery.s3.ap-south-1.amazonaws.com/gallery/202508/689c58aba3945.png\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://console.authkey.io/restapi/convjson.php","urlObject":{"protocol":"https","path":["restapi","convjson.php"],"host":["console","authkey","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"33b86668-0799-42df-9d0a-5a765e50f0d1"}],"id":"ec1fce35-859b-4768-90c1-d563d5abd6ca","_postman_id":"ec1fce35-859b-4768-90c1-d563d5abd6ca","description":""}],"id":"97ac08ee-4465-492e-b5b3-fab6606de849","_postman_id":"97ac08ee-4465-492e-b5b3-fab6606de849","description":""},{"name":"Send RCS","item":[{"name":"Bulk RCS","item":[{"name":"Bulk RCS","id":"1b436736-9943-4471-ad2b-179ae1f59108","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"version\": \"1.0\",\n \"authkey\": \"AUTHKEY\",\n \"encrpt\": \"0\",\n \"template_id\": \"template_id\",\n \"country_code\": \"91\",\n \"is_unicode\": 0,\n \"sender\": \"AUTHKY\",\n \"biz_extra\": \"XXXXXX\",\n \"messages\": [\n {\n \"dest\": [\n \"Customer1_number\",\n \"customer2_number\"\n ],\n \"param\": {\n \"var1\": \"value\",\n \"var2\": \"value\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://console.authkey.io/restapi/bulkrcs_json.php","urlObject":{"protocol":"https","path":["restapi","bulkrcs_json.php"],"host":["console","authkey","io"],"query":[],"variable":[]}},"response":[{"id":"6a8f4068-130d-4695-b7a9-949bf3d98f2b","name":"Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"version\":\"1.0\",\n\"authkey\":\"xxxxxxx\",\n\"encrpt\":\"0\",\n\"template_id\":\"11367\",\n\"country_code\":\"91\",\n\"is_unicode\":0,\n\"sender\":\"AUTHKY\",\n\"biz_extra\":\"XXXXXX\",\n\"messages\":[{\"dest\":[\"xxxxxxx\",\"xxxxxxxx\"],\"param\":{\"name\":\"suraj\",\"company\":\"datagen\"}}]\n}","options":{"raw":{"language":"json"}}},"url":"https://console.authkey.io/restapi/bulkrcs_json.php"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 17 Apr 2025 11:39:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"600"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"code\": 200,\n \"LogID\": \"2048e9155bfe43a26822317d06084881\",\n \"Message\": \"Submitted Successfully\"\n}"}],"_postman_id":"1b436736-9943-4471-ad2b-179ae1f59108"}],"id":"dfea8e36-1dbc-4882-9a3c-afd9fc2dc15b","_postman_id":"dfea8e36-1dbc-4882-9a3c-afd9fc2dc15b","description":""}],"id":"f660347b-21bf-4748-b822-e5218bdcf5c7","_postman_id":"f660347b-21bf-4748-b822-e5218bdcf5c7","description":""},{"name":"Send Email","item":[{"name":"Send Approved Template","id":"17c943fd-626f-4f44-bee5-bbb34c0e1cae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"BasicSend emails effortlessly using Authkey.io APIs and ensure your messages reach the recipient’s inbox every time.
\nCreate email templates directly in the Authkey.io portal.
\nUse the Template ID in your API requests for seamless integration.
\nTemplates can include dynamic placeholders for values in both the email body and subject. For example:
\nOTP messages
\nPromotional emails
\nTransactional emails
\nTo use the email service via Authkey, ensure the following:
\nAmazon AWS SES Account:
\nAn active AWS SES account is required to send emails.
\nDon’t have one? Click here to create your AWS SES account.
\nSending voice calls using Authkey.io APIs is simple and hassle-free. There’s no need for complex setups—just ensure your voice template is approved, and you’re ready to use it directly through the API.
\nAuthkey.io comes with an integrated Text-to-Speech (TTS) system that automatically converts text into speech. To send a voice call, use below API endpoints you can use to send voice calls to any number:
\n","_postman_id":"f534a32a-a286-40b5-9787-48a1b67f5d44"},{"name":"Get Template detail","item":[{"name":"authkey.io_getTemplateDetails","id":"26f8a8c7-657a-407a-8a2b-79198a39ec28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"BasicGet template details from the panel via API.
\n","_postman_id":"92bf2c02-8d02-4b55-aedd-532a78c6364a"},{"name":"CheckBalance","item":[{"name":"Get Balance","id":"ae6066fd-bea2-4f2a-9176-a3a62a0faa18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic=Your authkey portal authkey
\n"}],"body":{"mode":"raw","raw":" {\r\n \"country_code\": \"91\",\r\n \"mobile\": \"xxxx\",\r\n \"wid\": \"150\",\r\n \"type\": \"text\" \r\n }"},"url":"https://authkey.io/restapi/requestjson.php","description":"json reciever
\n","urlObject":{"protocol":"https","path":["restapi","requestjson.php"],"host":["authkey","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"ae6066fd-bea2-4f2a-9176-a3a62a0faa18"}],"id":"882ed9f5-d738-4d83-8623-975eee2ab741","_postman_id":"882ed9f5-d738-4d83-8623-975eee2ab741","description":""},{"name":"Media Upload","item":[{"name":"Media Upload API","id":"792dcd0f-fc9b-400e-905d-a83e46e34f22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Basic xxxxxxxxxx","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"doc_name","value":"file1","type":"text"},{"key":"file_name","type":"file","src":"postman-cloud:///1f028221-1a12-4d20-ada7-5d564a2cc6e5"}]},"url":"https://console.authkey.io/restapi/uploadMedia.php","urlObject":{"protocol":"https","path":["restapi","uploadMedia.php"],"host":["console","authkey","io"],"query":[],"variable":[]}},"response":[{"id":"d6633eb6-027b-4419-941f-4a1e443b055d","name":"Media Upload API","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic xxxxxxxx","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"doc_name","value":"file1","type":"text"},{"key":"file_name","type":"file","src":"postman-cloud:///1f028221-1a12-4d20-ada7-5d564a2cc6e5"}]},"url":"https://console.authkey.io/restapi/uploadMedia.php"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Sun, 04 May 2025 07:09:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"600"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"File Upload Successfully\",\n \"url\": \"https://wpgallery.s3.ap-south-1.amazonaws.com/gallery/202505/681712b62f522.pdf\"\n}"}],"_postman_id":"792dcd0f-fc9b-400e-905d-a83e46e34f22"}],"id":"51e6aa32-5e2f-42a6-80a1-37b2a19f0405","_postman_id":"51e6aa32-5e2f-42a6-80a1-37b2a19f0405","description":""}],"event":[{"listen":"prerequest","script":{"id":"d078d773-227e-411d-9255-c7009dc9da21","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"217f553b-6740-4406-b277-76d67f0e9809","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://farming-simulator.pstmn.io"}]}