Quick Send

Waste no time installing SDK. Try out the Quick API.

This endpoint is used to get an authorization token from the server. The token will be used to authenticate requests to protected endpoints

Acquire API KEY FROM DASHBOARD

Endpoints:

https://bulkdev.swifttdial.com:2778/api/outbox/create
header 'Content-Type: application/json' \
header 'X-API-Key: your-api-key you generate from the dashboard' \

REQUEST PARAMETERS

Parameter	Description
AUTHORIZATION	x-api-key
REQUEST BODY SCHEMA	Content-Type: application/json
profile_code	linked to sms product configuration
Messages	String
dlr_callback_url	The Url that we will send you a delivery report once the message is terminated to the device

json

{
 "profile_code": "12345",
    "messages": [
        {
            "recipient": "2547xxxxxxxx",
            "message": " Hi test successful",
            "message_type":1,
            "req_type": 1,
            "external_id": "unique_external_id"
        }
    ],
    "dlr_callback_url": "https://posthere.io"
}

POST

Send Message

Curl

curl --request POST \
 --url https://bulkdev.swifttdial.com:2778/api/outbox/create \
 --header 'Content-Type: application/json' \
 --header 'x-api-key' \
 --data '{
   "profile_code": "12345",
   "messages": [
       {
           "recipient" : "2547XXXXXXX",
           "message" : "test message",
           "message_type" : 1,
           "req_type": 1,
           "external_id" : "external_id"
       }
   ],
   "dlr_callback_url": "https://posthere.io/"
    } 

node

var axios = require('axios');
var data = JSON.stringify({
  "profile_code": "12345",
  "messages": [
    {
      "recipient": "2547XXXXXXXX",
      "message": " Test sucessfull ",
      "message_type": 1,
      "req_type": 1,
      "external_id": "unique_external_id"
    }
  ],
  "dlr_callback_url": "https://posthere.io/"
});

var config = {
  method: 'post',
  url: 'https://bulkdev.swifttdial.com:2778/api/outbox/create',
  headers: { 
    'x-api-key': 'your-api-key',
    'conent-type': '', 
    'Content-Type': 'application/json', 
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Python

import requests
import json

url = "https://bulkdev.swifttdial.com:2778/api/outbox/create"

payload = json.dumps({
  "profile_code": "12345",
  "messages": [
    {
      "recipient": "254792XXXXXX",
      "message": " Test message ",
      "message_type": 1,
      "req_type": 1,
      "external_id": "Your unique external_id"
    }
  ],
  "dlr_callback_url": "https://posthere.io/"
})
headers = {
  'x-api-key': 'your-api-key',
  'conent-type': '',
  'Content-Type': 'application/json',
  }

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)


POSThere.io - Debug all the POST requests
https://posthere.io

:::

Responses

Sample Responses

200

{
"external_id": "your_unique_external_id",
"recipient": "2547XXXXXXXX",
"sms_count": 1
}

401

{
"details": "description",
}

403

{
"details": "description",
}

422

{
"details": "Invalid Profile Code",
}

500

{
"details": "500 server-error",
}