Dexpatch SMS API Documentation

Welcome to Dexpatch SMS API documentation!

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 Parameter

  1. contacts = The list of contact ids to send the message
  2. groups = The list of group ids to send the message
  3. numbers = The list of number ids to send the message
  4. type = The type (text, call, tts ) of the message
  5. 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 Parameter

Parameter Description
loginPerform account login to validate a user
profileThe customer profile of the account
balanceThe current balance on the account
contactsThe type (text, call, tts ) of the message
numbersThe saved numbers on the account
groupsThe groups on the account
audiosThe saved audios on the account
historyThe message history on the account
scheduledThe scheduled messages on the account
reportsThe delivery reports on the account
paymentsThe payment history on the account

Error Codes:

Code Message
000Request successful
100Incomplete request parameters
101Request denied
110Login status failed
111Login status denied
120Message limit reached
121Mobile limit reached
122Sender limit reached
130Sender prohibited
131Message prohibited
140Invalid price setup
141Invalid route setup
142Invalid schedule date
150Insufficient funds
151Gateway denied access
152Service denied access
160File upload error
161File upload limit
162File restricted
190Maintenance in progress
191Internal error