Dexpatch API Integration Guide
This guide helps developers integrate their applications with Dexpatch to send and manage SMS, voice calls, and more programmatically.
Text Message
http://sms.dexpatch.com.ng/api/?username=user&password=pass&message=test&sender=welcome&mobiles=2348030000000,2348020000000
Example Responses:
Success Response: {"status":"OK","count":1,"price":2}
Failed Response: {"error":"Login denied." ,"errno":"103"}
Other Optional Parameters
- contacts – The list of contact IDs to send the message
- groups – The list of group IDs to send the message
- numbers – The list of number IDs to send the message
- type – The type (text, call, tts) of the message
- message – Message text or audio reference number
Call Message
http://sms.dexpatch.com.ng/api/?username=user&password=pass&message=391000&sender=2348030000000&mobiles=2348020000000&type=call
Upload Audio
sms.dexpatch.com.ng/api/?username=623512d06c&password=f4e50093a6&action=upload&url=sms.dexpatch.com.ng/demo/sample.mp3
{"status":"success","error":"","errno":"","data":{"reference":"ac798a79-f9e9-4662-c85b-f53ae1e62691","seconds":22,"size":"339.78KB"}}
Send TTS
sms.dexpatch.com.ng/api/?username=623512d06c&password=f4e50093a6&message=welcome+to+trillion.&type=tts&sender=2348040000000&mobiles=2348030000000
{"status":"success","error":"","errno":"","data":{"f75cfaec-5565-2044-449a-71f474f9f7d7":"2348030000000"}}
Send Audio
sms.dexpatch.com.ng/api/?username=623512d06c&password=f4e50093a6&message=ac798a79-f9e9-4662-c85b-f53ae1e62691&type=call&sender=441120000000&mobiles=441130000000
{"status":"success","error":"","errno":"","data":{"b5703ef4-9730-c56e-d884-a314fe974cd6":441130000000}}
Fetching Data
http://sms.dexpatch.com.ng/api/?username=user&password=pass&action=balance
Other Parameters
| Parameter |
Description |
| login | Perform account login to validate a user |
| profile | The customer profile of the account |
| balance | The current balance on the account |
| contacts | The type (text, call, tts) of the message |
| numbers | The saved numbers on the account |
| groups | The groups on the account |
| audios | The saved audios on the account |
| history | The message history on the account |
| scheduled | The scheduled messages on the account |
| reports | The delivery reports on the account |
| payments | The payment history on the account |
Error Codes
| Code |
Message |
| 000 | Request successful |
| 100 | Incomplete request parameters |
| 101 | Request denied |
| 110 | Login status failed |
| 111 | Login status denied |
| 120 | Message limit reached |
| 121 | Mobile limit reached |
| 122 | Sender limit reached |
| 130 | Sender prohibited |
| 131 | Message prohibited |
| 140 | Invalid price setup |
| 141 | Invalid route setup |
| 142 | Invalid schedule date |
| 150 | Insufficient funds |
| 151 | Gateway denied access |
| 152 | Service denied access |
| 160 | File upload error |
| 161 | File upload limit |
| 162 | File restricted |
| 190 | Maintenance in progress |
| 191 | Internal error |