This documentation will provide instructions on how to quickly integrate Sendpk.Com messaging services into various solutions.
\nServices:
\nBased on standard communication channels, we have developed a set of feature rich services, to help with your business needs:
\nRegister
In order to use our API, you will need credentials. You will need username , passowrd & api_key. These credentails can be obtained by creating an account and then by logging in cutomer portal.
Account Verification
Verify Your Account By Providing
a) CNIC
b) Face ID
c) Legal Agreement On Your Letter Head
e) NTN
Note!
This is a local channel for terminating local/Pakistani origin companies/products/services traffic only, terminating traffic of any international entity directly or indirectly is considered is a crime and can lead to legal action for damages/losses incurred.
API Parameters
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"9576087","collectionId":"c46b21d5-b25d-4946-9d8a-a6dac5298296","publishedId":"2s9YyvBg5s","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-02-03T07:36:32.000Z"},"item":[{"name":"Send Single Message","id":"a8661c86-d3cf-4640-b588-128cfbc8e38e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"api_key","value":"{{API_KEY}}","description":"Your Unuque API Key, Get From Your Profile:\nhttps://sendpk.com/dashboard/profile.php
\n","type":"text"},{"key":"sender","value":"{{BRAND NAME}}","description":"Sender - Masking - Brand Name
\n","type":"text"},{"key":"mobile","value":"{{923XXXX}}","description":"International Format Like 92300XXX
\n","type":"text"},{"key":"template_id","value":"{{Template_ID}}","description":"Your approved Fixed-SMS template ID.\nManage Your Templates: https://sendpk.com/dashboard/templates_fixed.php\nOr fetch them via the List My Templates request below.
\n","type":"text"},{"key":"message","value":"{\"name\":\"Aslam\",\"otp\":\"1234\"}","description":"Your template's variable values as a JSON string, e.g. {\"name\":\"Aslam\",\"otp\":\"1234\"} for the template \"Hello #name#, your OTP code is #otp#\". The wording itself is fixed in your approved template — this is only the values that change.
\n","type":"text"},{"key":"format","value":"json","description":"output response: json - xml - plain
\n","type":"text"}]},"url":"https://sendpk.com/api/sms.php","urlObject":{"protocol":"https","path":["api","sms.php"],"host":["sendpk","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a8661c86-d3cf-4640-b588-128cfbc8e38e"},{"name":"Send Multiple Messages","id":"9260a066-c7ef-4f92-bc9a-e6b6669f7f9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"api_key","value":"{{API_KEY}}","description":"Your Unuque API Key, Get From Your Profile:\nhttps://sendpk.com/dashboard/profile.php
\n","type":"text"},{"key":"sender","value":"{{BRAND NAME}}","description":"Sender - Masking - Brand Name
\n","type":"text"},{"key":"mobile","value":"{{92300XXX,92313XXX,9233XXX}}","description":"Comma-separated list, International Format
\n","type":"text"},{"key":"template_id","value":"{{Template_ID}}","description":"Your approved Fixed-SMS template ID.\nManage Your Templates: https://sendpk.com/dashboard/templates_fixed.php\nOr fetch them via the List My Templates request below.
\n","type":"text"},{"key":"message","value":"{\"name\":\"Aslam\",\"amount\":\"2500\",\"date\":\"15 Sep\"}","description":"Your template's variable values as a JSON string, e.g. {\"name\":\"Aslam\",\"otp\":\"1234\"} for the template \"Hello #name#, your OTP code is #otp#\". The wording itself is fixed in your approved template — this is only the values that change.
\n","type":"text"},{"key":"format","value":"json","description":"output response: json - xml - plain
\n","type":"text"}]},"url":"https://sendpk.com/api/sms.php","urlObject":{"protocol":"https","path":["api","sms.php"],"host":["sendpk","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9260a066-c7ef-4f92-bc9a-e6b6669f7f9a"},{"name":"Send Unicode Message","id":"5ecc020b-0809-4fb1-ba8a-350b710408cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"api_key","value":"{{API_KEY}}","description":"Your Unuque API Key, Get From Your Profile:\nhttps://sendpk.com/dashboard/profile.php
\n","type":"text"},{"key":"sender","value":"{{BRAND NAME}}","description":"Sender - Masking - Brand Name
\n","type":"text"},{"key":"mobile","value":"{{923XXXX}}","description":"International Format Like 92300XXX
\n","type":"text"},{"key":"template_id","value":"{{Template_ID}}","description":"Your approved Fixed-SMS template ID.\nManage Your Templates: https://sendpk.com/dashboard/templates_fixed.php\nOr fetch them via the List My Templates request below.
\n","type":"text"},{"key":"message","value":"{\"name\":\"اسلم\",\"order_id\":\"4471\"}","description":"Your template's variable values as a JSON string, e.g. {\"name\":\"Aslam\",\"otp\":\"1234\"} for the template \"Hello #name#, your OTP code is #otp#\". The wording itself is fixed in your approved template — this is only the values that change. URL-encode this value when it contains non-Latin characters.
\n","type":"text"},{"key":"format","value":"json","description":"output response: json - xml - plain
\n","type":"text"},{"key":"type","value":"unicode","description":"Set to unicode for emoji / non-Latin script text.
\n","type":"text"}]},"url":"https://sendpk.com/api/sms.php","urlObject":{"protocol":"https","path":["api","sms.php"],"host":["sendpk","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5ecc020b-0809-4fb1-ba8a-350b710408cf"},{"name":"Send Schedule Message","id":"07c61c83-a691-4013-a91b-cc580ac0254d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"api_key","value":"{{API_KEY}}","description":"Your Unuque API Key, Get From Your Profile:\nhttps://sendpk.com/dashboard/profile.php
\n","type":"text"},{"key":"sender","value":"{{BRAND NAME}}","description":"Sender - Masking - Brand Name
\n","type":"text"},{"key":"mobile","value":"{{923XXXX}}","description":"International Format Like 92300XXX
\n","type":"text"},{"key":"message","value":"Hello World - This Is A Service Test Message From SENDPK.COM - Via API","description":"Your Text Message
\n","type":"text"},{"key":"format","value":"json","description":"output response: json - xml - plain
\n","type":"text"}]},"url":"https://sendpk.com/api/sms.php","urlObject":{"protocol":"https","path":["api","sms.php"],"host":["sendpk","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"07c61c83-a691-4013-a91b-cc580ac0254d"},{"name":"Send Dynamic Message","id":"d45328d0-cf92-4225-b67f-251f48f15c15","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"api_key","value":"{{API_KEY}}","description":"Your Unuque API Key, Get From Your Profile:\nhttps://sendpk.com/dashboard/profile.php
\n","type":"text"},{"key":"sender","value":"{{MASK}}","description":"Sender - Masking - Brand Name
\n","type":"text"},{"key":"url","value":"https://sendpk.com/api/xls_sample.xls","description":"Publicly reachable link to your .txt/.csv/.xls/.xlsx file.
\n","type":"text"},{"key":"template_id","value":"{{Template_ID}}","description":"Your approved Fixed-SMS template ID.\nManage Your Templates: https://sendpk.com/dashboard/templates_fixed.php\nOr fetch them via the List My Templates request below.
\n","type":"text"},{"key":"message","value":"{\"name\":\"#B#\",\"marks\":\"#C#\",\"subject\":\"#D#\"}","description":"Your template's variable values as JSON, with a #COLUMN# reference for each one — e.g. #B# pulls from column B of the file, so every recipient gets their own row's values.
\n","type":"text"},{"key":"duplicate","value":"1","description":"0 removes duplicate numbers, 1 keeps them.
\n","type":"text"},{"key":"format","value":"json","description":"output response: json - xml - plain
\n","type":"text"}]},"url":"https://sendpk.com/api/personalised.php","description":"Send bulk SMS with unique information for every contact in a file (.txt, .csv, .xls, .xlsx) — no need to loop single sends.
\n","urlObject":{"protocol":"https","path":["api","personalised.php"],"host":["sendpk","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d45328d0-cf92-4225-b67f-251f48f15c15"},{"name":"Send OTP Message (Short Code Users Only)","id":"0fd78800-6408-4fd8-95b9-cfa4d2ec56d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"api_key","value":"{{API_KEY}}","description":"Your Unuque API Key, Get From Your Profile:\nhttps://sendpk.com/dashboard/profile.php
\n","type":"text"},{"key":"sender","value":"{{BRAND NAME}}","description":"Sender - Masking - Brand Name
\n","type":"text"},{"key":"mobile","value":"{{923XXXX}}","description":"International Format Like 92300XXX
\n","type":"text"},{"key":"template_id","value":"{{Template_ID}}","description":"Fixed Message Template ID
\nManage Your Templates:\nhttps://sendpk.com/dashboard/templates_fixed.php
\n","type":"text"},{"key":"message","value":"{\"name\":\"Aslam\",\"otp\":\"1234\"}","description":"Example: {\"name\":\"Aslam\", \"otp\":\"1234\"}
\n","type":"text"},{"key":"format","value":"json","description":"output response: json - xml - plain
\n","type":"text"}]},"url":"https://sendpk.com/api/sms.php","description":"Please Visit This Blog Post For More Details
\nhttps://sendpk.com/blog/fixed-sms-api/
\n","urlObject":{"protocol":"https","path":["api","sms.php"],"host":["sendpk","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0fd78800-6408-4fd8-95b9-cfa4d2ec56d3"},{"name":"Send Voice Message | Text To Speech","id":"c6269ac6-998c-440e-b1d3-c7240f049d8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"api_key","value":"{{Your_API_KEY}}","description":"Your Unuque API Key, Get From Your Profile:\nhttps://sendpk.com/dashboard/profile.php
\n","type":"text"},{"key":"type","value":"3","description":"1=Template Message, 2=Recorded Message, 3=Text To Speech
\n","type":"text"},{"key":"mobile","value":"{{923XXX}}","description":"International Format Like 92300XXX,92313XXX
\n","type":"text"},{"key":"text","value":"Your Verification Code is 12345","description":"Your Message
\n","type":"text"}]},"url":"https://sendpk.com/api/voicesms.php","urlObject":{"protocol":"https","path":["api","voicesms.php"],"host":["sendpk","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c6269ac6-998c-440e-b1d3-c7240f049d8b"},{"name":"Send Voice Message | Template Message","id":"747d9cf7-f33f-4dd7-9bfb-580e6bc23a36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"api_key","value":"{{Your_API_KEY}}","description":"Your Unuque API Key, Get From Your Profile:\nhttps://sendpk.com/dashboard/profile.php
\n","type":"text"},{"key":"type","value":"1","description":"1=Template Message, 2=Recorded Message, 3=Text To Speech
\n","type":"text"},{"key":"mobile","value":"{{923XXX}}","description":"International Format Like 92300XXX,92313XXX
\n","type":"text"},{"key":"audio","value":"{{Template_ID}}","description":"Saved Templated ID
\nManage Your Templates:\nhttps://sendpk.com/dashboard/Voicetemplates.php
\n","type":"text"}]},"url":"https://sendpk.com/api/voicesms.php","urlObject":{"protocol":"https","path":["api","voicesms.php"],"host":["sendpk","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"747d9cf7-f33f-4dd7-9bfb-580e6bc23a36"},{"name":"Send Voice Message | Recorded Message","id":"a0d6a045-e70b-4a5f-b928-ab1255ede9dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"api_key","value":"{{Your_API_KEY}}","description":"Your Unuque API Key, Get From Your Profile:\nhttps://sendpk.com/dashboard/profile.php
\n","type":"text"},{"key":"type","value":"2","description":"1=Template Message, 2=Recorded Message, 3=Text To Speech
\n","type":"text"},{"key":"mobile","value":"{{923xxx}}","description":"International Format Like 92300XXX,92313XXX
\n","type":"text"},{"key":"format","value":"json","description":"output response: json - xml - plain
\n","type":"text"},{"key":"file","description":"Local File: Wav - Mp3
\n","type":"file","value":null}]},"url":"https://sendpk.com/api/voicesms.php","urlObject":{"protocol":"https","path":["api","voicesms.php"],"host":["sendpk","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a0d6a045-e70b-4a5f-b928-ab1255ede9dc"},{"name":"Send Voice Message | DTMF - Feed Back Call - Order Confirmation Call","id":"2a222b65-e687-4c8e-91f1-9765a2cc2318","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"api_key","value":"{{Your_API_KEY}}","description":"Your Unuque API Key, Get From Your Profile:\nhttps://sendpk.com/dashboard/profile.php
\n","type":"text"},{"key":"type","value":"2","description":"1=Template Message, 2=Recorded Message, 3=Text To Speech
\n","type":"text"},{"key":"mobile","value":"{{923xxx}}","description":"International Format Like 92300XXX,92313XXX
\n","type":"text"},{"key":"format","value":"json","description":"output response: json - xml - plain
\n","type":"text"},{"key":"file","description":"Local File: Wav - Mp3
\n","type":"file","value":null},{"key":"dtmf","value":"1","description":"dtmf=1 To Enable this Option To Collect The Client Response
\n","type":"text"},{"key":"dtmf_timeout","value":"5","description":"The Waiting Time Period in Seconds For End User To Enter DTMF Digits
\n","type":"text"},{"key":"dtmf_max","value":"{{NUMBER OF DIGIT}}","description":"Defines the maximum number of DTMF codes entered by end user that would be collected. Limit 1 - 10
\n","type":"text"}]},"url":"https://sendpk.com/api/voicesms.php","description":"This Service Will Collect The Client Phone Keys Press Data, For Example: We Want To Confirm A Order From A Client, A Call Will Be Receive & Client Will Ask To Press 1 For Order Confirmation & Press 2 For Order Cancellation, As Soon As Client Press Any Key On His Mobile Device, We Will Receive His Response Instantly. This Response Will Then Be Forwarded Securely To Your Defined Callback Url (Server) Via The Post Method.
To Set Up Your Callback Url And Ensure Seamless Integration, Please Reach Out To Our Dedicated Support Team. They Will Assist You In Configuring The Callback Url To Meet Your Specific Needs And Preferences.
Your Unuque API Key, Get From Your Profile:\nhttps://sendpk.com/dashboard/profile.php
\n","type":"text/plain"},"key":"api_key","value":"{{API_KEY}}"},{"description":{"content":"output response: json - xml - plain
\n","type":"text/plain"},"key":"format","value":"json"}],"variable":[]}},"response":[],"_postman_id":"0a5176fc-ed4a-4543-bb8f-7c89e227524f"},{"name":"Check Delivery Reports","id":"238fcf6d-7d87-4da8-a92f-b702d9e0b90f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sendpk.com/api/delivery.php?api_key={{API_KEY}}&id={{UNIQUE_IDS}}","urlObject":{"protocol":"https","path":["api","delivery.php"],"host":["sendpk","com"],"query":[{"description":{"content":"Your Unuque API Key, Get From Your Profile:\nhttps://sendpk.com/dashboard/profile.php
\n","type":"text/plain"},"key":"api_key","value":"{{API_KEY}}"},{"description":{"content":"Comma Seperated Delivery IDS Like: 74d77cd4-72d1-4eb1-bcf4-100b9d5d8566,392d2fb9-5984-4baf-a326-236c705ff532
\n","type":"text/plain"},"key":"id","value":"{{UNIQUE_IDS}}"}],"variable":[]}},"response":[],"_postman_id":"238fcf6d-7d87-4da8-a92f-b702d9e0b90f"},{"name":"List My Templates","id":"1e2fbdd0-12aa-44f3-9e9c-9142b94de6b4","request":{"method":"GET","header":[],"url":"https://sendpk.com/apps/fetch_all_fixed_templates.php?api_key={{API_KEY}}","description":"Returns every approved Fixed-SMS template on your account, each with the template_id you pass when sending, so you never have to copy an ID out of the dashboard by hand.
\n","urlObject":{"protocol":"https","path":["apps","fetch_all_fixed_templates.php"],"host":["sendpk","com"],"query":[{"description":{"content":"Your Unuque API Key, Get From Your Profile:\nhttps://sendpk.com/dashboard/profile.php
\n","type":"text/plain"},"key":"api_key","value":"{{API_KEY}}"}],"variable":[]}},"response":[],"_postman_id":"1e2fbdd0-12aa-44f3-9e9c-9142b94de6b4"}]}