Send SMS (DND)
Using a GET method, you can send notification SMS to your customers whose phone numbers are placed on the Do-Not-Disturb (DND) mode on VTpass Messaging using the API end point below:
Live URL: https://messaging.vtpass.com/api/sms/dnd-route
NOTE: This route attracts a higher rate (most likely twice as much as the normal route) per SMS page sent
Authentication
Make sure to pass your Public Key and Secret Key as Authentication in the header to access the API
header: { X-Token: VT_PK_XXXXXXXXXXXXXXXXXXXXXXX X-Secret: VT_SK_XXXXXXXXXXXXXXXXXXXXXX }
Request Pattern:
To fetch your unit balance on VTpass Messaging, you may hit the balance endpoint while passing your keys via the header as shown above:
URL: https://messaging.vtpass.com/api/sms/dnd-route?sender={sender}&recipient={recipient}&message={message}&responsetype={responsetype}
FIELDS | Mandatory/Optional | TYPE | DESCRIPTION |
---|---|---|---|
sender | M | string | This is the name your users will see on their mobile phone as the sender of this SMS. For an example, it can be VTpass. |
recipient | M | string | This is the phone number(s) of your users and can be sent as a string joined by commas (,) without spaces for more than one phone number. This can be 11 digits (or more for foreign numbers). For example: 08012345678,2347012345678,233500012223 |
message | M | string | This is the message content you wish to send to your users. This can be one or more of OTP, post transaction SMS, Marketing campaign SMS, Promo SMS, etc. |
responsetype | O | string | This is the type or pattern of response you are comfortable with or your platform best understands. This can be one of json, text or xml .NOTE: By default, our API returns text as responseType |
Expected Response:
TEXT RESPONSE:
TG00-MESSAGE PROCESSED:0000|2347061933309|1623425963075808467849264|SENT|MESSAGE SENT TO PROVIDER|MTNNG|NIGERIA |999|0000-00-00 00:00:00
JSON RESPONSE:
{ "responseCode": "TG00", "response": "MESSAGE PROCESSED", "batchId": 5463323, "clientBatchId": null, "sentDate": "2021-06-11 16:36:45", "messages": [ { "statusCode": "0000", "recipient": "2347061933309", "messageId": "1623425805438752507784251", "status": "SENT", "description": "MESSAGE SENT TO PROVIDER", "network": "MTNNG", "country": "NIGERIA\r", "deliveryCode": "999", "deliveryDate": "0000-00-00 00:00:00", "bulkId": "1623425805465161413" } ] }
XML RESPONSE:
<?xml version="1.0"?> <root> <responseCode>TG00</responseCode> <response>MESSAGE PROCESSED</response> <clientId>5463326</clientId> <clientBatchId /> <sentDate>2021-06-11 16:40:33</sentDate> <messages> <item> <statusCode>0000</statusCode> <recipient>2347061933309</recipient> <messageId>1623426033925937673946634</messageId> <status>SENT</status> <description>MESSAGE SENT TO PROVIDER</description> <network>MTNNG</network> <country>NIGERIA</country> <deliveryCode>999</deliveryCode> <deliveryDate>0000-00-00 00:00:00</deliveryDate> <bulkId>1623426033496476560</bulkId> </item> </messages> </root>