The TeleOSS API Documentation provides comprehensive guidance and resources for developers looking to integrate with TeleOSS's services.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"45480387","collectionId":"9491b638-891f-4467-9e6d-caf5574b56c0","publishedId":"2sBY4Jx3MZ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-07-08T06:33:04.000Z"},"item":[{"name":"SMS","item":[{"name":"Send SMS","item":[{"name":"Send SMS","id":"2ea878ea-5519-4228-b63b-146f5e1c3e49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"apikey\": \"\",\n \"senderid\": \"\",\n \"unicode\": \"\",\n \"schedule\": \"\",\n \"sending-time\": \"\",\n \"sms-list\": [\n {\n \"message\": \"\",\n \"mobiles\": \"\",\n \"client-sms-ids\": \"\"\n },\n {\n \"message\": \"\",\n \"mobiles\": \"\",\n \"client-sms-ids\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://{Domain}/client/api/sendmessage?apikey={apikey}&mobiles={mobileno}&sms={message}&senderid={senderid}&schedule={schedule}&sending-time={dd-MM-yyyy HH:mm:ss}& client-sms-ids={id}&unicode={yes}&message-type={messageType}","urlObject":{"protocol":"https","path":["client","api","sendmessage"],"host":["{Domain}"],"query":[{"key":"apikey","value":"{apikey}"},{"key":"mobiles","value":"{mobileno}"},{"key":"sms","value":"{message}"},{"key":"senderid","value":"{senderid}"},{"key":"schedule","value":"{schedule}"},{"key":"sending-time","value":"{dd-MM-yyyy HH:mm:ss}"},{"key":" client-sms-ids","value":"{id}"},{"key":"unicode","value":"{yes}"},{"key":"message-type","value":"{messageType}"}],"variable":[]}},"response":[{"id":"f2b45d05-8115-4d45-a801-7248efa5faf6","name":"Send SMS","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"apikey\": \"\",\n \"senderid\": \"\",\n \"unicode\": \"\",\n \"schedule\": \"\",\n \"sending-time\": \"\",\n \"sms-list\": [\n {\n \"message\": \"\",\n \"mobiles\": \"\",\n \"client-sms-ids\": \"\"\n },\n {\n \"message\": \"\",\n \"mobiles\": \"\",\n \"client-sms-ids\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{Domain}/client/api/sendmessage?apikey={apikey}&mobiles={mobileno}&sms={message}&senderid={senderid}&schedule={schedule}&sending-time={dd-MM-yyyy HH:mm:ss}& client-sms-ids={id}&unicode={yes}&message-type={messageType}","protocol":"https","host":["{Domain}"],"path":["client","api","sendmessage"],"query":[{"key":"apikey","value":"{apikey}"},{"key":"mobiles","value":"{mobileno}"},{"key":"sms","value":"{message}"},{"key":"senderid","value":"{senderid}"},{"key":"schedule","value":"{schedule}"},{"key":"sending-time","value":"{dd-MM-yyyy HH:mm:ss}"},{"key":" client-sms-ids","value":"{id}"},{"key":"unicode","value":"{yes}"},{"key":"message-type","value":"{messageType}"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\"status\": {\n\"error-code\": \"\",\n\"error-status\": \"\",\n\"error-description\": \"\"\n},\n\"sms-response-details\": [\n{\n\"success-count\": \"\",\n\"failed-sms-details\": [\n{\n\"count\": \"\",\n\"reasons\": [\n{\n\"sms-client-id\": \"\",\n\"mobile-no\": \"\",\n\"failed-reason\": \"\",\n\"message-content\": \"\"\n}\n]\n}\n],\n\"sent-sms-details\": [\n{\n\"sms-client-id\": \"\",\n\"message-id\": \"\",\n\"mobile-no\": \"\"\n}\n]\n}\n]\n}"}],"_postman_id":"2ea878ea-5519-4228-b63b-146f5e1c3e49"}],"id":"250b16f7-e720-4723-9da9-42c8cc8a6a17","description":"HTTP based API will be used in sending SMS through TeleOSS.
\nParameters Detail:
\nError Codes -
\n","_postman_id":"250b16f7-e720-4723-9da9-42c8cc8a6a17"},{"name":"SMS Delivery","item":[{"name":"SMS Delivery","id":"13c407f1-7636-497b-91d9-409c8fdb07e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{Domain}/client/api/getdlr?apikey={apikey}&messageid={1,2}&externalid={1,2}&drquantity={X}&fromdate={yyyy-mm-dd hh:mm:ss{&todate={yyyy-mm-dd hh:mm:ss}","urlObject":{"protocol":"https","path":["client","api","getdlr"],"host":["{Domain}"],"query":[{"key":"apikey","value":"{apikey}"},{"key":"messageid","value":"{1,2}"},{"key":"externalid","value":"{1,2}"},{"key":"drquantity","value":"{X}"},{"key":"fromdate","value":"{yyyy-mm-dd hh:mm:ss{"},{"key":"todate","value":"{yyyy-mm-dd hh:mm:ss}"}],"variable":[]}},"response":[{"id":"8bb5a697-7dd0-4ed0-9af9-8a193f22f99e","name":"Get SMS Delivery Status","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://{Domain}/client/api/getdlr?apikey={apikey}&messageid={1,2}&externalid={1,2}&drquantity={X}&fromdate={yyyy-mm-dd hh:mm:ss{&todate={yyyy-mm-dd hh:mm:ss}","protocol":"https","host":["{Domain}"],"path":["client","api","getdlr"],"query":[{"key":"apikey","value":"{apikey}"},{"key":"messageid","value":"{1,2}"},{"key":"externalid","value":"{1,2}"},{"key":"drquantity","value":"{X}"},{"key":"fromdate","value":"{yyyy-mm-dd hh:mm:ss{"},{"key":"todate","value":"{yyyy-mm-dd hh:mm:ss}"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\"status\": {\n\"error-code\": \"\",\n\"error-status\": \"\",\n\"error-description\": \"\"\n},\n\"dlr-details\": {\n\"pending-dr-count\": \"\",\n\"dr-count\": \"\",\n\n\"dlr-list\": [{\n\"message-id\": \"\",\n\"external-id\": \"\"\n}\n]\n}\n}"}],"_postman_id":"13c407f1-7636-497b-91d9-409c8fdb07e7"}],"id":"ff33a131-232f-45c6-9c28-6aa000c64113","description":"HTTP based API will be used for get SMS Delivery through system.
\nOutput Parameter Description:
\nError Codes:
\n","_postman_id":"ff33a131-232f-45c6-9c28-6aa000c64113"},{"name":"SMPP Connection","item":[],"id":"be7fa806-2a18-4925-9125-c397005d4ce6","description":"Overview
\nTeleOSS SMPP Inbound API module is intended for users, who want to setup SMPP Client
connection with SMPP server of SMS Gateway Provider. We are assuming that you are using a
standard SMPP Client for connection. This document only contains information on how to use
SMPP for connection with SMS gateway.
Configuring SMPP Connection
You will be provided following information with your account.
• Host: IP/Domain
• Port: 8056
• User name (system_id): Login username for account authentication
• Password: Password of your account, provided along with User name for account
authentication.
• Maximum-Connection-Instance: Maximum number of connections, that can be established
at any particular instance of time.
• Bind Mode: TRANSCEIVER / TRANSMITTER / RECEIVER
• Delivery Registration: Success or Failure
Authentication
Account user name and password are provided for connecting to SMPP server of SMS Gateway
provider.
Parameter List
\n","_postman_id":"be7fa806-2a18-4925-9125-c397005d4ce6"},{"name":"DLR Acknowledgement","item":[{"name":"DLR Acknowledgement","id":"259d16d3-a53e-41f1-9b7b-e55d4818b7cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://{Domain}/client/api/getdlracknowledgement?apikey={apikey}&messageid={1,2}&externalid={1,2}&drquantity={X}&fromdate={yyyy-mm-dd hh:mm:ss}&todate={yyyy-mm-dd hh:mm:ss}","urlObject":{"protocol":"https","path":["client","api","getdlracknowledgement"],"host":["{Domain}"],"query":[{"key":"apikey","value":"{apikey}"},{"key":"messageid","value":"{1,2}"},{"key":"externalid","value":"{1,2}"},{"key":"drquantity","value":"{X}"},{"key":"fromdate","value":"{yyyy-mm-dd hh:mm:ss}"},{"key":"todate","value":"{yyyy-mm-dd hh:mm:ss}"}],"variable":[]}},"response":[{"id":"2874dfb0-9bf8-46c5-8787-d45d974b76b2","name":"Get DLR Acknowledgement","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://{Domain}/client/api/getdlracknowledgement?apikey={apikey}&messageid={1,2}&externalid={1,2}&drquantity={X}&fromdate={yyyy-mm-dd hh:mm:ss}&todate={yyyy-mm-dd hh:mm:ss}","protocol":"https","host":["{Domain}"],"path":["client","api","getdlracknowledgement"],"query":[{"key":"apikey","value":"{apikey}"},{"key":"messageid","value":"{1,2}"},{"key":"externalid","value":"{1,2}"},{"key":"drquantity","value":"{X}"},{"key":"fromdate","value":"{yyyy-mm-dd hh:mm:ss}"},{"key":"todate","value":"{yyyy-mm-dd hh:mm:ss}"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\"status\": {\n\"error-code\": \"\",\n\"error-status\": \"\",\n\"error-description\": \"\"\n},\n\"dlr-details\": {\n\"pending-dr-count\": \"\",\n\"dr-count\": \"\",\n\n\"dlr-list\": [{\n\"message-id\": \"\",\n\"external-id\": \"\"\n}\n]\n}\n}"}],"_postman_id":"259d16d3-a53e-41f1-9b7b-e55d4818b7cb"}],"id":"3d2f96a0-0189-43aa-b038-c7dc561e142e","description":"HTTP based API will be used for get SMS Delivery through system.
\nOutput Parameter Description
\nError Codes -
\n","_postman_id":"3d2f96a0-0189-43aa-b038-c7dc561e142e"},{"name":"Inbox","item":[{"name":"Inbox","id":"8311752f-22e3-40c3-968a-45fd145be0cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://{Domain}/client/api/inbox/receive/*","urlObject":{"protocol":"https","path":["client","api","inbox","receive","*"],"host":["{Domain}"],"query":[],"variable":[]}},"response":[{"id":"92007855-9010-4ab5-a115-e639a2d14015","name":"Inbox listener API","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"formdata","formdata":[],"options":{"raw":{"language":"json"}}},"url":{"raw":"https://{Domain}/client/api/inbox/receive/TEST?code={CODE}&message={MESSAGE}&sender={SENDER}","protocol":"https","host":["{Domain}"],"path":["client","api","inbox","receive","TEST"],"query":[{"key":"code","value":"{CODE}"},{"key":"message","value":"{MESSAGE}"},{"key":"sender","value":"{SENDER}"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\"status\": {\n\"error-code\": \"\",\n\"error-status\": \"\",\n\"error-description\": \"\"\n},\n\"inbox-detail\": {\n\"inbox-id\": \"\"\n}\n}"}],"_postman_id":"8311752f-22e3-40c3-968a-45fd145be0cf"}],"id":"12daab1a-b026-493d-bcc5-0e27d25f02f7","description":"HTTP based API will be used as Inbox listener through TeleOSS.
\nInput Parameter Description:
\nError Codes:
\n","_postman_id":"12daab1a-b026-493d-bcc5-0e27d25f02f7"},{"name":"Send OTP","item":[{"name":"Send OTP","id":"e6524c78-7d55-42a2-a956-09c8a9e6f38b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n\"api-key\":\"f0xxxxxxxxxa6\",\n\"mobile-no\":\"9852xx2542\",\n\"otp-system-type\":\"IxxC\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{Domain}/client/api/otp/send/{apikey}/{mobileno}/{system type}","urlObject":{"protocol":"https","path":["client","api","otp","send","{apikey}","{mobileno}","{system type}"],"host":["{Domain}"],"query":[],"variable":[]}},"response":[{"id":"fead754f-b111-49e3-bc7c-79f96ffcfe8d","name":"Send OTP","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n\"api-key\":\"f0xxxxxxxxa6\",\n\"mobile-no\":\"985xxxx542\",\n\"otp-system-type\":\"IxxC\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{Domain}/client/api/otp/send/{apikey}/{mobileno}/{system type}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\"mobile-no\": \"+91985xxxx521\",\n\"status\": {\n\"error-code\": \"000\",\n\"error-status\": \"Success\",\n\"error-description\": \"OTP generate successfully\"\n}\n}"}],"_postman_id":"e6524c78-7d55-42a2-a956-09c8a9e6f38b"}],"id":"2d4a564e-b333-419a-8364-a033787c5a1c","description":"HTTP based API will be used in OTP API through TeleOSS.
\nParameters Detail:
\n","_postman_id":"2d4a564e-b333-419a-8364-a033787c5a1c"},{"name":"Validate OTP","item":[{"name":"Validate OTP","id":"c23a682a-18b3-4507-b36d-c9b4635a972d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"api-key\":\"f06xxxxxdx2a6\",\n\"mobile-no\":\"985xxxx542\",\n\"otp\":\"UxxH\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{Domain}/client/api/otp/validate/{apiKey}/{otp}/{mobileNo}","urlObject":{"protocol":"https","path":["client","api","otp","validate","{apiKey}","{otp}","{mobileNo}"],"host":["{Domain}"],"query":[],"variable":[]}},"response":[{"id":"cce42a1e-757a-487f-a40d-eddf6555da0d","name":"Validate OTP","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"api-key\":\"f06xxxxxdx2a6\",\n\"mobile-no\":\"985xxxx542\",\n\"otp\":\"UxxH\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{Domain}/client/api/otp/validate/{apiKey}/{otp}/{mobileNo}"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n\"mobile-no\": \"+9198xxxxx542\",\n\"status\":\n{\n\"error-code\": \"000\",\n\"error-status\": \"Success\",\n\"error-description\": \"OTP Validate Successfully\"\n}\n}"}],"_postman_id":"c23a682a-18b3-4507-b36d-c9b4635a972d"},{"name":"Validate OTP","id":"17c126f6-5369-4bb4-b516-080b21022f48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n\"api-key\":\"f0xxxxexxxxa6\",\n\"mobile-no\":\"985xxxx542\",\n\"otp\":\"UxxH\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{Domain}/client/api/otp/validate/{apiKey}/{otp}/{mobileNo}","urlObject":{"protocol":"https","path":["client","api","otp","validate","{apiKey}","{otp}","{mobileNo}"],"host":["{Domain}"],"query":[],"variable":[]}},"response":[{"id":"a4f1fe7e-e0ed-438f-9681-8bc1e57e9e02","name":"Validate OTP","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://{Domain}/client/api/otp/validate/545xxxxxxxx5869/854625/985xxxx542"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\"mobile-no\": \"+91985xxxx542\",\n\"status\": {\n\"error-code\": \"000\",\n\"error-status\": \"Success\",\n\"error-description\": \"OTP Validate Successfully\"\n}\n}"}],"_postman_id":"17c126f6-5369-4bb4-b516-080b21022f48"}],"id":"3f4a4878-eb0e-4703-8d4d-784a8497b298","description":"Validate OTP Via HTTP Request:
\nParameters Detail:
\nError Codes -
\n","_postman_id":"3f4a4878-eb0e-4703-8d4d-784a8497b298"}],"id":"539a484c-75ef-4368-8989-9981e51ca67a","description":"Collection of SMS related TeleOSS API
\n","_postman_id":"539a484c-75ef-4368-8989-9981e51ca67a"},{"name":"WhatApp API","item":[{"name":"Send Text with Variables","event":[{"listen":"test","script":{"id":"16bfb54b-7c89-44f6-add2-cec44fc14ff7","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"d029b215-4742-4acc-bd48-8b258a8bc9f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"apikey\": \"545xyzxyzxyz5069\",\n \"message\": {\n \"data\": [\n {\n \"key\": \"waba-number\",\n \"value\": \"9198xxxxxxxx\",\n \"type\": \"text\"\n },\n {\n \"key\": \"mobiles\",\n \"value\": \"9199xxxxxxxx\",\n \"type\": \"text\"\n },\n {\n \"key\": \"template\",\n \"value\": \"templatename\",\n \"type\": \"text\"\n },\n {\n \"key\": \"header\",\n \"value\": \"\",\n \"type\": \"text\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"Alex\"\n }\n ]\n },\n {\n \"key\": \"body\",\n \"value\": \"\",\n \"type\": \"text\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"1234\"\n },\n {\n \"type\": \"text\",\n \"text\": \"60\"\n }\n ]\n },\n {\n \"key\": \"client-message-id\",\n \"value\": \"xxxxx\",\n \"type\": \"text\"\n },\n {\n \"type\": \"text\",\n \"value\": \"template\",\n \"key\": \"template-type\"\n }\n ]\n }\n}"},"url":"https://{Domain}/client/api/whatsapp","urlObject":{"protocol":"https","path":["client","api","whatsapp"],"host":["{Domain}"],"query":[],"variable":[]}},"response":[{"id":"5654c155-0e76-40d1-a827-d8d704b9302a","name":"Send Text with Variables","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"apikey\": \"545xyzxyzxyz5069\",\n \"message\": {\n \"data\": [\n {\n \"key\": \"waba-number\",\n \"value\": \"9198xxxxxxxx\",\n \"type\": \"text\"\n },\n {\n \"key\": \"mobiles\",\n \"value\": \"phonenumber\",\n \"type\": \"text\"\n },\n {\n \"key\": \"template\",\n \"value\": \"templatename\",\n \"type\": \"text\"\n },\n {\n \"key\": \"header\",\n \"value\": \"\",\n \"type\": \"text\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"textvalue\"\n }\n ]\n },\n {\n \"key\": \"body\",\n \"value\": \"\",\n \"type\": \"text\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"textvalue\"\n },\n {\n \"type\": \"text\",\n \"text\": \"textvalue\"\n }\n ]\n },\n {\n \"key\": \"client-message-id\",\n \"value\": \"xxxxx\",\n \"type\": \"text\"\n },\n {\n \"type\": \"text\",\n \"value\": \"template\",\n \"key\": \"template-type\"\n }\n ]\n }\n}"},"url":"https://{Domain}/client/api/whatsapp"},"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\"status\": {\n\"error-code\": \"\",\n\"error-status\": \"\",\n\"error-description\": \"\"\n},\n\"response-details\": [\n{\n\"success-count\": \"\",\n\"sent-details\": [\n{\n\"client-id\": \"\",\n\"message-id\": \"\",\n\"mobile-no\": \"\"\n}\n],\n\"failed-details\": [{\n\"count\": \"\",\n\"reasons\": [\n{\n\"client-id\": \"\",\n\"mobile-no\": \"\",\"failed-reason\": \"\",\n\"message-content\": \"\"\n}\n]\n}\n]\n}\n]\n}"}],"_postman_id":"d029b215-4742-4acc-bd48-8b258a8bc9f6"},{"name":"Send Header Image(ID)","id":"67e575f4-05f0-4015-af33-b822782df0f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"apikey\": \"545xyzxyzxyz5069\",\n \"message\": {\n \"data\": [\n {\n \"key\": \"waba-number\",\n \"value\": \"9198xxxxxxxx\",\n \"type\": \"text\"\n },\n {\n \"key\": \"mobiles\",\n \"value\": \"9199xxxxxxxx\",\n \"type\": \"text\"\n },\n {\n \"key\": \"template\",\n \"value\": \"templatename\",\n \"type\": \"text\"\n },\n {\n \"key\": \"header\",\n \"type\": \"mediaid\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"text\": \"233455645\"\n }\n ]\n },\n {\n \"key\": \"body\",\n \"value\": \"\",\n \"type\": \"text\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"1234\"\n },\n {\n \"type\": \"text\",\n \"text\": \"60\"\n }\n ]\n },\n {\n \"key\": \"client-message-id\",\n \"value\": \"xxxxx\",\n \"type\": \"text\"\n },\n {\n \"type\": \"text\",\n \"value\": \"template\",\n \"key\": \"template-type\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://{Domain}/client/api/whatsapp","urlObject":{"protocol":"https","path":["client","api","whatsapp"],"host":["{Domain}"],"query":[],"variable":[]}},"response":[{"id":"6646e96a-e067-4839-a7de-9a56f910402c","name":"Send Header Image(ID)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"apikey\": \"545xyzxyzxyz5069\",\n \"message\": {\n \"data\": [\n {\n \"key\": \"waba-number\",\n \"value\": \"9198xxxxxxxx\",\n \"type\": \"text\"\n },\n {\n \"key\": \"mobiles\",\n \"value\": \"phonenumber\",\n \"type\": \"text\"\n },\n {\n \"key\": \"template\",\n \"value\": \"templatename\",\n \"type\": \"text\"\n },\n {\n \"key\": \"header\",\n \"type\": \"mediaid\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"text\": \"imagemediaid\"\n }\n ]\n },\n {\n \"key\": \"body\",\n \"value\": \"\",\n \"type\": \"text\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"textvalue\"\n },\n {\n \"type\": \"text\",\n \"text\": \"textvalue\"\n }\n ]\n },\n {\n \"key\": \"client-message-id\",\n \"value\": \"xxxxx\",\n \"type\": \"text\"\n },\n {\n \"type\": \"text\",\n \"value\": \"template\",\n \"key\": \"template-type\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://{Domain}/client/api/whatsapp"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\"status\": {\n\"error-code\": \"\",\n\"error-status\": \"\",\n\"error-description\": \"\"\n},\n\"response-details\": [\n{\n\"success-count\": \"\",\n\"sent-details\": [\n{\n\"client-id\": \"\",\n\"message-id\": \"\",\n\"mobile-no\": \"\"\n}\n],\n\"failed-details\": [{\n\"count\": \"\",\n\"reasons\": [\n{\n\"client-id\": \"\",\n\"mobile-no\": \"\",\"failed-reason\": \"\",\n\"message-content\": \"\"\n}\n]\n}\n]\n}\n]\n}"}],"_postman_id":"67e575f4-05f0-4015-af33-b822782df0f0"},{"name":"Send Header Image(Link)","id":"1a1f32a0-5dea-4787-8086-efcb804873b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"apikey\": \"545xyzxyzxyz5069\",\n \"message\": {\n \"data\": [\n {\n \"key\": \"waba-number\",\n \"value\": \"9198xxxxxxxx\",\n \"type\": \"text\"\n },\n {\n \"key\": \"mobiles\",\n \"value\": \"9199xxxxxxxx\",\n \"type\": \"text\"\n },\n {\n \"key\": \"template\",\n \"value\": \"templatename\",\n \"type\": \"text\"\n },\n {\n \"key\": \"header\",\n \"type\": \"medialink\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"text\": \"https://xyz....\"\n }\n ]\n },\n {\n \"key\": \"body\",\n \"value\": \"\",\n \"type\": \"text\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"1234\"\n },\n {\n \"type\": \"text\",\n \"text\": \"60\"\n }\n ]\n },\n {\n \"key\": \"client-message-id\",\n \"value\": \"xxxxx\",\n \"type\": \"text\"\n },\n {\n \"type\": \"text\",\n \"value\": \"template\",\n \"key\": \"template-type\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://{Domain}/client/api/whatsapp","urlObject":{"protocol":"https","path":["client","api","whatsapp"],"host":["{Domain}"],"query":[],"variable":[]}},"response":[{"id":"17a12759-7ad4-4082-99a3-e9eb7343b617","name":"Send Header Image(Link)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"apikey\": \"545xyzxyzxyz5069\",\n \"message\": {\n \"data\": [\n {\n \"key\": \"waba-number\",\n \"value\": \"9198xxxxxxxx\",\n \"type\": \"text\"\n },\n {\n \"key\": \"mobiles\",\n \"value\": \"9199xxxxxxxx\",\n \"type\": \"text\"\n },\n {\n \"key\": \"template\",\n \"value\": \"templatename\",\n \"type\": \"text\"\n },\n {\n \"key\": \"header\",\n \"type\": \"medialink\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"text\": \"https://xyz....\"\n }\n ]\n },\n {\n \"key\": \"body\",\n \"value\": \"\",\n \"type\": \"text\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"1234\"\n },\n {\n \"type\": \"text\",\n \"text\": \"60\"\n }\n ]\n },\n {\n \"key\": \"client-message-id\",\n \"value\": \"xxxxx\",\n \"type\": \"text\"\n },\n {\n \"type\": \"text\",\n \"value\": \"template\",\n \"key\": \"template-type\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://{Domain}/client/api/whatsapp"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\"status\": {\n\"error-code\": \"\",\n\"error-status\": \"\",\n\"error-description\": \"\"\n},\n\"response-details\": [\n{\n\"success-count\": \"\",\n\"sent-details\": [\n{\n\"client-id\": \"\",\n\"message-id\": \"\",\n\"mobile-no\": \"\"\n}\n],\n\"failed-details\": [{\n\"count\": \"\",\n\"reasons\": [\n{\n\"client-id\": \"\",\n\"mobile-no\": \"\",\n\"failed-reason\": \"\",\n\"message-content\": \"\"\n}\n]\n}\n]\n}\n]\n}"}],"_postman_id":"1a1f32a0-5dea-4787-8086-efcb804873b5"},{"name":"Send Header Document(ID)","id":"e272ec9b-bc17-44c6-98f5-bcaebf5d9549","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"apikey\": \"545xyzxyzxyz5069\",\n \"message\": {\n \"data\": [\n {\n \"key\": \"waba-number\",\n \"value\": \"9198xxxxxxxx\",\n \"type\": \"text\"\n },\n {\n \"key\": \"mobiles\",\n \"value\": \"9199xxxxxxxx\",\n \"type\": \"text\"\n },\n {\n \"key\": \"template\",\n \"value\": \"templatename\",\n \"type\": \"text\"\n },\n {\n \"key\": \"header\",\n \"value\": \"xyz.pdf\",\n \"type\": \"mediaid\",\n \"parameters\": [\n {\n \"type\": \"document\",\n \"text\": \"233455645\"\n }\n ]\n },\n {\n \"key\": \"body\",\n \"value\": \"\",\n \"type\": \"text\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"1234\"\n },\n {\n \"type\": \"text\",\n \"text\": \"60\"\n }\n ]\n },\n {\n \"key\": \"client-message-id\",\n \"value\": \"xxxxx\",\n \"type\": \"text\"\n },\n {\n \"type\": \"text\",\n \"value\": \"template\",\n \"key\": \"template-type\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://{Domain}/client/api/whatsapp","urlObject":{"protocol":"https","path":["client","api","whatsapp"],"host":["{Domain}"],"query":[],"variable":[]}},"response":[{"id":"18e74c64-7748-4944-95cc-729342955416","name":"Send Header Document(ID)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"apikey\": \"545xyzxyzxyz5069\",\n \"message\": {\n \"data\": [\n {\n \"key\": \"waba-number\",\n \"value\": \"9198xxxxxxxx\",\n \"type\": \"text\"\n },\n {\n \"key\": \"mobiles\",\n \"value\": \"9199xxxxxxxx\",\n \"type\": \"text\"\n },\n {\n \"key\": \"template\",\n \"value\": \"templatename\",\n \"type\": \"text\"\n },\n {\n \"key\": \"header\",\n \"value\": \"xyz.pdf\",\n \"type\": \"mediaid\",\n \"parameters\": [\n {\n \"type\": \"document\",\n \"text\": \"233455645\"\n }\n ]\n },\n {\n \"key\": \"body\",\n \"value\": \"\",\n \"type\": \"text\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"1234\"\n },\n {\n \"type\": \"text\",\n \"text\": \"60\"\n }\n ]\n },\n {\n \"key\": \"client-message-id\",\n \"value\": \"xxxxx\",\n \"type\": \"text\"\n },\n {\n \"type\": \"text\",\n \"value\": \"template\",\n \"key\": \"template-type\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://{Domain}/client/api/whatsapp"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\"status\": {\n\"error-code\": \"\",\n\"error-status\": \"\",\n\"error-description\": \"\"\n},\n\"response-details\": [\n{\n\"success-count\": \"\",\n\"sent-details\": [\n{\n\"client-id\": \"\",\n\"message-id\": \"\",\n\"mobile-no\": \"\"\n}\n],\n\"failed-details\": [{\n\"count\": \"\",\n\"reasons\": [\n{\n\"client-id\": \"\",\n\"mobile-no\": \"\",\n\"failed-reason\": \"\",\n\"message-content\": \"\"\n}\n]\n}\n]\n}\n]\n}"}],"_postman_id":"e272ec9b-bc17-44c6-98f5-bcaebf5d9549"},{"name":"Send Header Document(Link)","id":"3345138e-5d1b-4e73-afb1-063bfc256345","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"apikey\": \"545xyzxyzxyz5069\",\n \"message\": {\n \"data\": [\n {\n \"key\": \"waba-number\",\n \"value\": \"9198xxxxxxxx\",\n \"type\": \"text\"\n },\n {\n \"key\": \"mobiles\",\n \"value\": \"9199xxxxxxxx\",\n \"type\": \"text\"\n },\n {\n \"key\": \"template\",\n \"value\": \"templatename\",\n \"type\": \"text\"\n },\n {\n \"key\": \"header\",\n \"value\": \"xyz.pdf\",\n \"type\": \"medialink\",\n \"parameters\": [\n {\n \"type\": \"document\",\n \"text\": \"https://xyz....\"\n }\n ]\n },\n {\n \"key\": \"client-message-id\",\n \"value\": \"client-1757916609\",\n \"type\": \"text\"\n },\n {\n \"type\": \"text\",\n \"value\": \"template\",\n \"key\": \"template-type\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://{Domain}/client/api/whatsapp","urlObject":{"protocol":"https","path":["client","api","whatsapp"],"host":["{Domain}"],"query":[],"variable":[]}},"response":[{"id":"1999e24e-2fd9-491b-8d96-e14bab9b9cee","name":"Send Header Document(Link)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"apikey\": \"545xyzxyzxyz5069\",\n \"message\": {\n \"data\": [\n {\n \"key\": \"waba-number\",\n \"value\": \"9198xxxxxxxx\",\n \"type\": \"text\"\n },\n {\n \"key\": \"mobiles\",\n \"value\": \"phonenumber\",\n \"type\": \"text\"\n },\n {\n \"key\": \"template\",\n \"value\": \"templatename\",\n \"type\": \"text\"\n },\n {\n \"key\": \"header\",\n \"value\": \"pdfname.pdf\",\n \"type\": \"medialink\",\n \"parameters\": [\n {\n \"type\": \"document\",\n \"text\": \"https://xyz....\"\n }\n ]\n },\n {\n \"key\": \"body\",\n \"value\": \"\",\n \"type\": \"text\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"textvalue\"\n },\n {\n \"type\": \"text\",\n \"text\": \"textvalue\"\n }\n ]\n },\n {\n \"key\": \"client-message-id\",\n \"value\": \"xxxxx\",\n \"type\": \"text\"\n },\n {\n \"type\": \"text\",\n \"value\": \"template\",\n \"key\": \"template-type\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://{Domain}/client/api/whatsapp"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\"status\": {\n\"error-code\": \"\",\n\"error-status\": \"\",\n\"error-description\": \"\"\n},\n\"response-details\": [\n{\n\"success-count\": \"\",\n\"sent-details\": [\n{\n\"client-id\": \"\",\n\"message-id\": \"\",\n\"mobile-no\": \"\"\n}\n],\n\"failed-details\": [{\n\"count\": \"\",\n\"reasons\": [\n{\n\"client-id\": \"\",\n\"mobile-no\": \"\",\"failed-reason\": \"\",\n\"message-content\": \"\"\n}\n]\n}\n]\n}\n]\n}"}],"_postman_id":"3345138e-5d1b-4e73-afb1-063bfc256345"},{"name":"Send CTA Button","id":"c9b05716-6e42-4871-9cdb-b263120f936f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"apikey\": \"545xyzxyzxyz5069\",\n \"message\": {\n \"data\": [\n {\n \"key\": \"waba-number\",\n \"value\": \"9198xxxxxxxx\",\n \"type\": \"text\"\n },\n {\n \"key\": \"mobiles\",\n \"value\": \"9199xxxxxxxx\",\n \"type\": \"text\"\n },\n {\n \"key\": \"template\",\n \"value\": \"templatename\",\n \"type\": \"text\"\n },\n {\n \"key\": \"header\",\n \"value\": \"\",\n \"type\": \"text\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"Alex\"\n }\n ]\n },\n {\n \"key\": \"body\",\n \"value\": \"\",\n \"type\": \"text\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"1234\"\n },\n {\n \"type\": \"text\",\n \"text\": \"60\"\n }\n ]\n },\n {\n \"key\": \"button\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"xxx\",\n \"index\": \"0\"\n },\n {\n \"type\": \"text\",\n \"text\": \"yyy\",\n \"index\": \"1\"\n }\n ]\n },\n {\n \"key\": \"client-message-id\",\n \"value\": \"xxxxx\",\n \"type\": \"text\"\n },\n {\n \"type\": \"text\",\n \"value\": \"template\",\n \"key\": \"template-type\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://{Domain}/client/api/whatsapp","urlObject":{"protocol":"https","path":["client","api","whatsapp"],"host":["{Domain}"],"query":[],"variable":[]}},"response":[{"id":"b7283f01-fc4f-4c19-9a12-74e67b0c1656","name":"Send CTA Button","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"apikey\": \"545xyzxyzxyz5069\",\n \"message\": {\n \"data\": [\n {\n \"key\": \"waba-number\",\n \"value\": \"9198xxxxxxxx\",\n \"type\": \"text\"\n },\n {\n \"key\": \"mobiles\",\n \"value\": \"9199xxxxxxxx\",\n \"type\": \"text\"\n },\n {\n \"key\": \"template\",\n \"value\": \"templatename\",\n \"type\": \"text\"\n },\n {\n \"key\": \"header\",\n \"value\": \"\",\n \"type\": \"text\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"Alex\"\n }\n ]\n },\n {\n \"key\": \"body\",\n \"value\": \"\",\n \"type\": \"text\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"textvalue\"\n },\n {\n \"type\": \"text\",\n \"text\": \"textvalue\"\n }\n ]\n },\n {\n \"key\": \"button\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"button dynamic link\",\n \"index\": \"0\"\n },\n {\n \"type\": \"text\",\n \"text\": \"button dynamic link\",\n \"index\": \"1\"\n }\n ]\n },\n {\n \"key\": \"client-message-id\",\n \"value\": \"xxxxx\",\n \"type\": \"text\"\n },\n {\n \"type\": \"text\",\n \"value\": \"template\",\n \"key\": \"template-type\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://{Domain}/client/api/whatsapp"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\"status\": {\n\"error-code\": \"\",\n\"error-status\": \"\",\n\"error-description\": \"\"\n},\n\"response-details\": [\n{\n\"success-count\": \"\",\n\"sent-details\": [\n{\n\"client-id\": \"\",\n\"message-id\": \"\",\n\"mobile-no\": \"\"\n}\n],\n\"failed-details\": [{\n\"count\": \"\",\n\"reasons\": [\n{\n\"client-id\": \"\",\n\"mobile-no\": \"\",\"failed-reason\": \"\",\n\"message-content\": \"\"\n}\n]\n}\n]\n}\n]\n}"}],"_postman_id":"c9b05716-6e42-4871-9cdb-b263120f936f"}],"id":"758c3cb6-368a-447a-a650-3b0f627234ba","description":"This Documentation provide WhatsApp API Guidence
\n