{"info":{"_postman_id":"1085b684-341b-486b-b918-b99564e89f27","name":"Branded SMS Pakistan","description":"# BrandedSMS REST API\r\n\r\n----\r\n## Introduction\r\n\r\nWelcome to the BrandedSMS API documentation!\r\n\r\nOur API provides a set of flexible tools which you can use to create new outstanding projects. We smile a bit more each time we see skilled developers unleash their creativity!\r\n\r\n## Basic API usage\r\nAll LiveChat API requests start with\r\n\r\n    https://bsms.hostandsoft.com/app/sms/\r\n\r\n\r\nPlease note that all BrandedSMS API requests must use `HTTPS` protocol.\r\n\r\n# API response\r\n\r\n## Response format\r\n\r\nBy default our API respond back in JSON format but you have rights to choose in which format you would like to get the response, as we support `json` and `xml` output.\r\n\r\nTo get the desired output you may include `response=json` or `response=xml` in your API request\r\n\r\n## Successful Responses\r\n\r\n* 200 success\r\n* 201 Successfully Send\r\n* 202 SMS scheduled successfully\r\n* 207 Subscription successfully done\r\n* 208 Contact already subscribed\r\n* 209 OTP Generated\r\n* 210 Code Matched successfully.\r\n\r\n## Error Response Code\r\n\r\n* 401 Authentication Failed\r\n* 101 Bad gateway requested\r\n* 103 Invalid Phone Number\r\n* 104 Parameters Missing\r\n* 105 Insufficient balance\r\n* 106 Invalid Sender id\r\n* 107 Invalid SMS Type\r\n* 108 SMS gateway not active\r\n* 109 Invalid schedule time for campaign\r\n* 110 Media URL required\r\n* 111 SMS contain SPAM word, wait for approval\r\n* 112 Destination number contain in blacklist number\r\n* 113 Invalid Template Match\r\n* 114 No Country Found\r\n* 115 No senderid available for your account\r\n* 116 Phone coverage not active\r\n* 117 Subscription failed. Please try again\r\n* 118 Subscription list not found\r\n* 119 no groups available for your account\r\n* 120 invalid otp provided","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json"},"item":[{"name":"Check Balance","item":[{"name":"Check Balance","id":"98c7a224-919d-46af-8864-d928f33cb876","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"https://bsms.hostandsoft.com/app/sms/api?action=check-balance&api_key=YOUR API KEY","protocol":"https","host":["bsms","hostandsoft","com"],"path":["app","sms","api"],"query":[{"key":"action","value":"check-balance","description":"`required`"},{"key":"api_key","value":"YOUR API KEY","description":"`required`"}]}},"response":[],"_postman_id":"98c7a224-919d-46af-8864-d928f33cb876"},{"name":"Check Balance","id":"077c09bc-d976-4624-821b-e613ee32c822","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"action","value":"check-balance","description":"`required`","type":"text"},{"key":"api_key","value":"YOUR API KEY","description":"`required`","type":"text"}]},"url":"https://bsms.hostandsoft.com/app/sms/api"},"response":[],"_postman_id":"077c09bc-d976-4624-821b-e613ee32c822"}],"id":"43a377e6-0f13-4a58-8354-e06a8bd8eb9a","description":"You may check the account balance with GET or POST request as per your requirement but we recommend to use the POST requests.\r\n","event":[{"listen":"prerequest","script":{"id":"f8627de9-d048-4156-b8c6-73d640517318","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b844b0a0-005c-4f80-9070-f329c4c7ca77","type":"text/javascript","exec":[""]}}],"_postman_id":"43a377e6-0f13-4a58-8354-e06a8bd8eb9a"},{"name":"Contacts","item":[{"name":"Get Template","id":"8574fae3-4e0e-4f2d-8e21-275d65743cd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"https://bsms.hostandsoft.com/app/sms/api?action=get-template&api_key=YOUR API KEY","protocol":"https","host":["bsms","hostandsoft","com"],"path":["app","sms","api"],"query":[{"key":"action","value":"get-template","description":"`required`"},{"key":"api_key","value":"YOUR API KEY","description":"`required`"}]}},"response":[],"_postman_id":"8574fae3-4e0e-4f2d-8e21-275d65743cd2"},{"name":"Get Template","id":"aad7f295-7006-47da-a839-b53cbee006c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"action","value":"get-template","equals":true,"description":"`required`"},{"key":"api_key","value":"YOUR API KEY","equals":true,"description":"`required`"}]},"url":"https://bsms.hostandsoft.com/app/sms/api"},"response":[],"_postman_id":"aad7f295-7006-47da-a839-b53cbee006c4"},{"name":"Get Phonebook","id":"5cbfea45-5d70-4a4b-945c-fcb3fc72b9d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"https://bsms.hostandsoft.com/app/sms/api?action=get-phonebook&api_key=YOUR API KEY","protocol":"https","host":["bsms","hostandsoft","com"],"path":["app","sms","api"],"query":[{"key":"action","value":"get-phonebook","description":"`required`"},{"key":"api_key","value":"YOUR API KEY","description":"`required`"}]}},"response":[],"_postman_id":"5cbfea45-5d70-4a4b-945c-fcb3fc72b9d9"},{"name":"Get Phonebook","id":"a0aa381f-6823-410d-9699-197b6fb3afd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"action","value":"get-phonebook","equals":true,"description":"`required`"},{"key":"api_key","value":"YOUR API KEY","equals":true,"description":"`required`"}]},"url":"https://bsms.hostandsoft.com/app/sms/api"},"response":[],"_postman_id":"a0aa381f-6823-410d-9699-197b6fb3afd2"},{"name":"Subscribe Contact","id":"fa6be4df-68d2-4426-bd48-5d6c323b56ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"https://bsms.hostandsoft.com/app/contacts/api?action=subscribe-us&api_key=YOUR API KEY&company=COMPANY NAME&user_name=USER NAME&first_name=FIRST NAME&last_name=LAST NAME&email=EMAIL ADDRESS&phone_number=PHONE NUMBER&phone_book=PHONEBOOK","protocol":"https","host":["bsms","hostandsoft","com"],"path":["app","contacts","api"],"query":[{"key":"action","value":"subscribe-us","description":"`required`"},{"key":"api_key","value":"YOUR API KEY","description":"`required`"},{"key":"company","value":"COMPANY NAME"},{"key":"user_name","value":"USER NAME"},{"key":"first_name","value":"FIRST NAME"},{"key":"last_name","value":"LAST NAME"},{"key":"email","value":"EMAIL ADDRESS"},{"key":"phone_number","value":"PHONE NUMBER","description":"`required`"},{"key":"phone_book","value":"PHONEBOOK","description":"`required`\n\nName of phonebook which could be obtained from `Get Phonebook` API call"}]}},"response":[],"_postman_id":"fa6be4df-68d2-4426-bd48-5d6c323b56ec"},{"name":"Subscribe Contact","id":"eaad034f-6b13-4fdc-a4bc-d76e1b743c1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"action","value":"subscribe-us","equals":true,"description":"`required`"},{"key":"api_key","value":"YOUR API KEY","equals":true,"description":"`required`"},{"key":"company","value":"COMPANY NAME","equals":true},{"key":"name","value":"NAME","equals":true},{"key":"fname","value":"FIRST NAME","equals":true},{"key":"lname","value":"LAST NAME","equals":true},{"key":"email","value":"EMAIL ADDRESS","equals":true},{"key":"phone_number","value":"PHONE NUMBER","equals":true,"description":"`required`"},{"key":"phone_book","value":"PHONEBOOK","equals":true,"description":"`required`\n\nName of phonebook which could be obtained from `Get Phonebook` API call"}]},"url":"https://bsms.hostandsoft.com/app/contacts/api"},"response":[],"_postman_id":"eaad034f-6b13-4fdc-a4bc-d76e1b743c1b"}],"id":"2d7d7aee-a896-43b3-859e-c90874454291","_postman_id":"2d7d7aee-a896-43b3-859e-c90874454291"},{"name":"Sender ID","item":[{"name":"Get Sender IDs","id":"628e89da-a3a8-43d4-842c-16a7e4b8ef7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"https://bsms.hostandsoft.com/app/sms/api?action=sender-id&api_key=YOUR API KEY","protocol":"https","host":["bsms","hostandsoft","com"],"path":["app","sms","api"],"query":[{"key":"action","value":"sender-id","description":"`required`"},{"key":"api_key","value":"YOUR API KEY","description":"`required`"}]}},"response":[],"_postman_id":"628e89da-a3a8-43d4-842c-16a7e4b8ef7f"},{"name":"Get Sender IDs","id":"5c24c912-a8de-4767-a861-08ae2fbfade1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"action","value":"sender-id","description":"`required`","type":"text"},{"key":"api_key","value":"YOUR API KEY","description":"`required`","type":"text"}]},"url":"https://bsms.hostandsoft.com/app/sms/api"},"response":[],"_postman_id":"5c24c912-a8de-4767-a861-08ae2fbfade1"}],"id":"40242476-e2e3-4504-bc36-0ab90f53fb31","description":"To get the list of all Sender IDs also known as Masking IDs, you may use the API below","event":[{"listen":"prerequest","script":{"id":"f8627de9-d048-4156-b8c6-73d640517318","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b844b0a0-005c-4f80-9070-f329c4c7ca77","type":"text/javascript","exec":[""]}}],"_postman_id":"40242476-e2e3-4504-bc36-0ab90f53fb31"},{"name":"Send SMS","item":[{"name":"Send Text Message","id":"9ad6226d-161c-48b0-a163-ead46569a1e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"https://bsms.hostandsoft.com/app/sms/api?action=send-sms&api_key=YOUR API KEY&to=RECIPIENT NUMBER &from=SENDER ID&sms=MESSAGE","protocol":"https","host":["bsms","hostandsoft","com"],"path":["app","sms","api"],"query":[{"key":"action","value":"send-sms","description":"`required`"},{"key":"api_key","value":"YOUR API KEY","description":"`required`"},{"key":"to","value":"RECIPIENT NUMBER ","description":"`required`"},{"key":"from","value":"SENDER ID","description":"`required`"},{"key":"sms","value":"MESSAGE","description":"`required`"}]}},"response":[],"_postman_id":"9ad6226d-161c-48b0-a163-ead46569a1e0"},{"name":"Send Text Message","id":"bf569a7d-e32b-4964-a25b-4996f5bfc534","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"action","value":"send-sms","description":"`required`","type":"text"},{"key":"api_key","value":"YOUR API KEY","description":"`required`","type":"text"},{"key":"to","value":"RECIPIENT NUMBER ","description":"`required`","type":"text"},{"key":"from","value":"SENDER ID","description":"`required`","type":"text"},{"key":"sms","value":"MESSAGE","description":"`required`","type":"text"}]},"url":"https://bsms.hostandsoft.com/app/sms/api"},"response":[],"_postman_id":"bf569a7d-e32b-4964-a25b-4996f5bfc534"},{"name":"Send Unicode Message","id":"77b22093-8b17-4ff5-ab5a-ccdf12c00f36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"https://bsms.hostandsoft.com/app/sms/api?action=send-sms&api_key=YOUR API KEY&to=RECIPIENT NUMBER &from=SENDER ID&sms=MESSAGE&unicode=1","protocol":"https","host":["bsms","hostandsoft","com"],"path":["app","sms","api"],"query":[{"key":"action","value":"send-sms","description":"`required`"},{"key":"api_key","value":"YOUR API KEY","description":"`required`"},{"key":"to","value":"RECIPIENT NUMBER ","description":"`required`"},{"key":"from","value":"SENDER ID","description":"`required`"},{"key":"sms","value":"MESSAGE","description":"`required`"},{"key":"unicode","value":"1","description":"`required`"}]}},"response":[],"_postman_id":"77b22093-8b17-4ff5-ab5a-ccdf12c00f36"},{"name":"Send Unicode Message","id":"7e0a8e57-d4cd-4ecd-9d66-e454ef67be05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"`required`","key":"action","type":"text","value":"send-sms"},{"description":"`required`","key":"api_key","type":"text","value":"YOUR API KEY"},{"description":"`required`","key":"to","type":"text","value":"RECIPIENT NUMBER "},{"description":"`required`","key":"from","type":"text","value":"SENDER ID"},{"description":"`required`","key":"sms","type":"text","value":"MESSAGE"},{"key":"unicode","value":"1","description":"`required`","type":"text"}]},"url":"https://bsms.hostandsoft.com/app/sms/api"},"response":[],"_postman_id":"7e0a8e57-d4cd-4ecd-9d66-e454ef67be05"},{"name":"Send Scheduled Message","id":"a410253a-5045-40e3-9780-d96048881b04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"https://bsms.hostandsoft.com/app/sms/api?action=send-sms&api_key=YOUR API KEY&to=RECIPIENT NUMBER &from=SENDER ID&sms=MESSAGE&schedule=SCHEDULE TIME","protocol":"https","host":["bsms","hostandsoft","com"],"path":["app","sms","api"],"query":[{"key":"action","value":"send-sms","description":"`required`"},{"key":"api_key","value":"YOUR API KEY","description":"`required`"},{"key":"to","value":"RECIPIENT NUMBER ","description":"`required`"},{"key":"from","value":"SENDER ID","description":"`required`"},{"key":"sms","value":"MESSAGE","description":"`required`"},{"key":"schedule","value":"SCHEDULE TIME","description":"`required`\n\nDate/Time format (m/d/Y h:i A) i.e. 01/28/2020 6:05 PM"}]}},"response":[],"_postman_id":"a410253a-5045-40e3-9780-d96048881b04"},{"name":"Send Scheduled Message","id":"72ceb83f-c30b-4195-ba27-131573931785","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"`required`","key":"action","type":"text","value":"send-sms"},{"description":"`required`","key":"api_key","type":"text","value":"YOUR API KEY"},{"description":"`required`","key":"to","type":"text","value":"RECIPIENT NUMBER "},{"description":"`required`","key":"from","type":"text","value":"SENDER ID"},{"description":"`required`","key":"sms","type":"text","value":"MESSAGE"},{"key":"schedule","value":"SCHEDULE TIME","description":"`required`\n\nDate/Time format (m/d/Y h:i A) i.e. 01/28/2020 6:05 PM","type":"text"}]},"url":"https://bsms.hostandsoft.com/app/sms/api"},"response":[],"_postman_id":"72ceb83f-c30b-4195-ba27-131573931785"}],"id":"5c8150fd-3be3-43f6-9f78-17a630aeddcb","description":"In order to send SMS you may utilize our rich set of API features with different parameters to make the most of our system.","event":[{"listen":"prerequest","script":{"id":"f8627de9-d048-4156-b8c6-73d640517318","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b844b0a0-005c-4f80-9070-f329c4c7ca77","type":"text/javascript","exec":[""]}}],"_postman_id":"5c8150fd-3be3-43f6-9f78-17a630aeddcb"},{"name":"SMS History","item":[{"name":"SMS History","id":"c6ec2656-4e83-409d-b1d3-c6c2e6a7563b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"https://bsms.hostandsoft.com/app/sms/api?action=get-inbox&api_key=YOUR API KEY","protocol":"https","host":["bsms","hostandsoft","com"],"path":["app","sms","api"],"query":[{"key":"action","value":"get-inbox","description":"`required`"},{"key":"api_key","value":"YOUR API KEY","description":"`required`"}]}},"response":[],"_postman_id":"c6ec2656-4e83-409d-b1d3-c6c2e6a7563b"},{"name":"SMS History","id":"837cb41d-b5ff-4d73-9122-f5e47f5027e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"`required`","equals":true,"key":"action","value":"get-inbox"},{"description":"`required`","equals":true,"key":"api_key","value":"YOUR API KEY"}]},"url":"https://bsms.hostandsoft.com/app/sms/api"},"response":[],"_postman_id":"837cb41d-b5ff-4d73-9122-f5e47f5027e8"}],"id":"ecb91e9b-281d-46e3-a557-fbb42fd22d61","description":"You may get the history of all messages with this API call.","event":[{"listen":"prerequest","script":{"id":"4f686e9e-29ea-4889-a15b-496ab24bcb89","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"710eaf8d-32e6-4595-98ed-5815bde061d6","type":"text/javascript","exec":[""]}}],"_postman_id":"ecb91e9b-281d-46e3-a557-fbb42fd22d61"},{"name":"OTP","item":[{"name":"Generate OTP","id":"29f171ca-ba69-4ed5-a7c6-c52ddaa03de1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"https://bsms.hostandsoft.com/app/sms/api?action=generate-otp&api_key=YOUR API KEY&phone_number=PHONE NUMBER&senderid=SENDER ID&template=TEMPLATE","protocol":"https","host":["bsms","hostandsoft","com"],"path":["app","sms","api"],"query":[{"key":"action","value":"generate-otp","description":"`required`"},{"key":"api_key","value":"YOUR API KEY","description":"`required`"},{"key":"phone_number","value":"PHONE NUMBER","description":"`required`\nphone number of recipient"},{"key":"senderid","value":"SENDER ID","description":"`required`"},{"key":"template","value":"TEMPLATE","description":"`required`\nSMS template that should include the tag `[otp]`\n\nThe SMS would be delivered to the recipient along with the code in place of `[otp]` like an example below\n\n    Hi,\n    Your verification Code is : 1353"}]}},"response":[],"_postman_id":"29f171ca-ba69-4ed5-a7c6-c52ddaa03de1"},{"name":"Generate OTP","id":"9492a5ce-f6e8-46df-bebd-b82be1634cda","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"`required`","key":"action","type":"text","value":"generate-otp"},{"key":"api_key","value":"YOUR API KEY","description":"`required`","type":"text"},{"description":"`required`\nphone number of recipient","key":"phone_number","type":"text","value":"PHONE NUMBER"},{"description":"`required`","key":"senderid","type":"text","value":"SENDER ID"},{"description":"`required`\nSMS template that should include the tag `[otp]`\n\nThe SMS would be delivered to the recipient along with the code in place of `[otp]` like an example below\n\n    Hi,\n    Your verification Code is : 1353","key":"template","type":"text","value":"TEMPLATE"}]},"url":"https://bsms.hostandsoft.com/app/sms/api"},"response":[],"_postman_id":"9492a5ce-f6e8-46df-bebd-b82be1634cda"},{"name":"Verify OTP","id":"56f460b0-d071-45f6-9a3b-8c9212c79d0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"https://bsms.hostandsoft.com/app/sms/api?action=verify-otp&api_key=YOUR API KEY&phone_number=PHONE NUMBER&senderid=SENDER ID&otp=OTP CODE","protocol":"https","host":["bsms","hostandsoft","com"],"path":["app","sms","api"],"query":[{"key":"action","value":"verify-otp","description":"`required`"},{"key":"api_key","value":"YOUR API KEY","description":"`required`"},{"key":"phone_number","value":"PHONE NUMBER","description":"`required`"},{"key":"senderid","value":"SENDER ID","description":"`required`"},{"key":"otp","value":"OTP CODE","description":"`required`"}]}},"response":[],"_postman_id":"56f460b0-d071-45f6-9a3b-8c9212c79d0c"},{"name":"Verify OTP","id":"5fc530d6-0a96-430d-93fb-d6df7c766c2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"`required`","key":"action","type":"text","value":"verify-otp"},{"key":"api_key","value":"YOUR API KEY","description":"`required`","type":"text"},{"description":"`required`","key":"phone_number","type":"text","value":"PHONE NUMBER"},{"description":"`required`","key":"senderid","type":"text","value":"SENDER ID"},{"description":"`required`","key":"otp","type":"text","value":"OTP CODE"}]},"url":"https://bsms.hostandsoft.com/app/sms/api"},"response":[],"_postman_id":"5fc530d6-0a96-430d-93fb-d6df7c766c2a"}],"id":"4b7a5c17-f0eb-436c-aefd-255c5c6a1feb","description":"OTP system is designed to provide security system to our Clients. Where you may first need to POST a call at `generate-otp` which would create a One Time Pass code and deliver it to the recipient provided.\r\n\r\nIn order to verify the Code you have to POST another call to `verify-otp` with required parameters to verify the OTP.","event":[{"listen":"prerequest","script":{"id":"32d31b83-e86f-4c30-9354-908312c7ed6d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"754075b3-ae1d-4f71-8934-8547a2affff2","type":"text/javascript","exec":[""]}}],"_postman_id":"4b7a5c17-f0eb-436c-aefd-255c5c6a1feb"}],"auth":{"type":"apikey","apikey":{"key":"api_key","in":"query"}},"event":[{"listen":"prerequest","script":{"id":"ef146b57-94be-4f52-ab45-66360dbab7dc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1089534e-0820-4f95-9840-e8900fb86e52","type":"text/javascript","exec":[""]}}],"variable":[{"key":"action","value":""},{"key":"to","value":""},{"key":"from","value":""},{"key":"sms","value":""},{"key":"unicode","value":""},{"key":"short_code","value":""},{"key":"voice","value":""},{"key":"mms","value":""},{"key":"media_url","value":""},{"key":"schedule","value":""},{"key":"phone_book","value":""},{"key":"phone_number","value":""},{"key":"otp","value":""},{"key":"senderid","value":""},{"key":"template","value":""},{"key":"name","value":""},{"key":"email","value":""},{"key":"fname","value":""},{"key":"lname","value":""},{"key":"company","value":""}]}