QUICK SMS RESTful APIs are the easiest way to build high-quality communication applications on the cloud. Integrate Quick SMS services into your software and transform your messaging and engagement experience. You can send alerts, reminders and notification via SMS and Voice, and verify your users using a one-time password and check your SMS status. This API documentation provides you with comprehensive guides and documentation to help you get started, with samples codes in Java, PHP, Python and Node.js. Our SMS APIs Interact with your customers using the most effective way of communication out there.Our SMS API is super developer-friendly and allows integration with your systems, and ensure there is no significant learning curve. You can access our platform to build and send out your campaigns and see each campaign's results separately. Our Phone Verification APIs Make your users feel secure with a one-time password. Generate a one-time password within 2 seconds to verify customer identity and transactions using SMS and Email. Verifying users' identity is essential in preventing fraud and securing accounts from compromise. Create an Account To get started, sign up for Quick SMS account if you don’t already have one. Begin by Signing with Google account or completing all the required fields, continue by verifying your phone number, and check your inbox for the verification email. After creating an account, you will receive six (6) free SMS credits to test our API's. API Key To use Quick SMS APIs, you’ll need to provide an API access key (Public key). To create your API access key, go to the Quick SMS Dashboard, navigate to API Integration tab. Here, you can generate a new Main API key (Private & Public) and also manage Multiple API Keys. Multiple API Keys is based on the idea that users may need sub-keys to limit or monitor usage and access the account without exposing existing keys or other use cases. For instance, a user may decide to create a sub-key for each school that uses the School Management System developed by the user. If you’re having any issues creating your API key, please reach out to info@linksengineering.net. Account Top-up To top-up your SMS account, navigate to Top up -> Buy credit on your sidebar. Choose a any Non-expiry plan that is best for you or enter an amount to purchase. The miminum amount is GHS 10. You can purchase with your MOMO or Card.
Send SMS This operation is used to send SMS to a single phone number or muliple phone numbers. NOTE: To send to multiple phone numbers, separate the phone numbers with a comma (,) when assigning them to the 'numbers' parameter. Setting up your API Setting up is easy and can be done using the steps below: 1. Sign in with your Account. Click here to Sign up 2. Click the API Integration tab on the Sidebar 3. Click API Keys 4. Generate New API Key 5. The Private key is automatically filled for you and can not be edited. You can create multiple Keys API Keys, Parameters & Codes The first step in Setting up your API is to click API Key under Api Integration and then click API key.. You can generate multiple API Keys and delete anytime. To use the API, you are required to have a Public key. Private key : Business Account ID Public key : Auto generate Sender : Your sender name Phone Numbers : 233XXXXXXXXXX,99XXXXXXXXX,234XXXXXXXX....... Message : Your message here API Endpoint https://linksengineering.net/apisms/api/qapi?public_key=xxx&sender=xxxx&numbers=xxxx&message=xxxx Alternative Endpoint https://sendquicksms.com/public/api/sms?public_key=xxx&sender=xxxx&numbers=xxxx&message=xxxx Secure Access All your API requests can be made via HTTP or HTTPS. For security reasons, we would however strongly recommend that you use HTTPS for all requests. Our servers use SHA-256 certificates, and support TLS v1.0, 1.1, 1.2 and 1.3.
One Time Password (OTP) Status Codes: Generate OTP 500 = Internal error 1000 = Successful, Message delivered 1002 = Message must contain a slot for otp code, like %otp_code% 1003 = This Sender ID have Blocked By Administrator 1004 = Invalid API key 1005 = invalid Phone Number 1006 = OTP is not allowed in your Country 1007 = Message scheduled for later delivery 1008 = Empty Message 1009 = You can not send more than 500 characters using voice medium 1011 = Internal error Status Codes: Verify OTP 1106 - Internal error 1105 = Code has expired 1000 = Successful 1102 - Invalid phone number 1103 - Invalid phone number 1104 - Invalid code Generate OTP This operation generates and sends a code to the receiver through the specified medium. The type and medium parameters have to be specified in the request. Parameters type [string: numeric | alphanumeric] - numeric: This operation generates code with only digits. - alphanumeric: This operation generates code with both digits and letters. medium [string: sms | voice] - sms: This operation sends a code as an SMS message using the template provided. - voice: This operation sends a code as a voice call using a registered caller ID. The supplied message text is translated to speech by our text to speech engine. expiry: [int: 1-10] This parameter refers to how long a code will last in minutes. The expiry value can be included in the OTP message adding %expiry% to the content. Example: This is OTP from Quick SMS, %otp_code%. Code will expiry in %expiry% minutes length: [int: 6-15] This parameter refers to the length of the generated code. message [string] Content of your message should go here. A one-page message = 160 character. A 200 characters messages will be 2 pages. Include the slot %otp_code% where the generated code should be inserted in the message.
VOICE SMS API This operation is used to send VOICE SMS to a single or multiple phone number(s). Setting up your API Setting up is easy and can be done using the steps below: 1. Sign in with your Account. Click here to Sign up 2. Click the API Integration tab on the Sidebar 3. Click API Keys 4. Generate New API Key 5. The Private key is automatically filled for you and can not be edited. You can create multiple Keys API Keys, Parameters & Codes The first step in Setting up your API is to click API Key under Api Integration and then click API key.. You can generate multiple API Keys and delete anytime. To use the API, you are required to have a Public key. Private key : Business Account ID Public key : Auto generate Voice File : Your uploaded voice file (E.g. 3889093874.mp3) - Hint: Upload your voice file (Not more than 4 minutes) on Quicksms (https://sms.linksengineering.net/voice) Phone Number : 233XXXXXXXXXX - To add multiple numbers, append comma (,) between the numbers. Example: 024XXXXXXXXXX,054XXXXXXXXXX,026XXXXXXXXXX API Endpoint https://voiceapi.linksengineering.net/api?public_key=xxxxxxxxx&numbers=024xxxxxxx&voice_file=3889093874.mp3 Secure Access All your API requests can be made via HTTP or HTTPS. For security reasons, we would however strongly recommend that you use HTTPS for all requests. Our servers use SHA-256 certificates, and support TLS v1.0, 1.1, 1.2 and 1.3.