Send SMS

Post

https://api.bunce.so/v1/messaging/transactional/send/sms

Send

If successful, your response includes a message that your message has been sent successfully. If there is an error with any of the parameters, it will return a 422 HTTP status code with details in an error object.

Request

Body Parameters required

sender_id string required	Sender ID
email string<email> nullable	Recipient email. Required if recipient customer_id is not sent
customer_id string nullable	Recipient Customer ID. Required if recipient email is not sent
message_type string required	Message Type
subject string required	Message Subject
message string required	Message Text
phone_no string nullable	Recipient phone number. Phone number should be international format. Required if customer does not already exist or does not have a phone number
template_id string optional	Template ID
variables object optional	Template variables, only required when template has variables

Variables Field

The variables field is an object that contains the values of the variables in the message template. The keys of the object should match the variable names in the template.

For example, if the template message is Hello, {{name}}! Your account balance is {{balance}}, the variables would be: name and balance.

name string required	The value of the name variable in the template.
balance string required	The value of the balance variable in the template.

Note that the above example is just an example and the actual values of the variables will depend on the context of the message.

cURL

curl --request POST \
  --url https://api.bunce.so/v1/messaging/transactional/send/sms \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: sk_live_************************' \
  --data '{
    "sender_id": "Bunce",
    "email" : "test@gmail.com",
    "message_type" : "otp",
    "subject" : "Reset Password OTP",
    "message" : "This is a message from Bunce",
    "phone_no": "+2349088798657"
}'

Go

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.bunce.so/v1/messaging/transactional/send/sms"

	payload := strings.NewReader("{\n    \"sender_id\": \"Bunce\",\n    \"email\" : \"test@gmail.com\",\n    \"message_type\" : \"otp\",\n    \"subject\" : \"Reset Password OTP\",\n    \"message\" : \"This is a message from Bunce\",\n    \"phone_no\": \"+2349088798657\"\n}")


	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Authorization", "sk_live_************************")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Node

const  = ('node-fetch')

let  = 'https://api.bunce.so/v1/messaging/transactional/send/sms'

let  = {
  : 'POST',
  : {
    'X-Authorization': 'sk_live_************************',
    'Content-Type': 'application/json',
  },
  : '{"sender_id":"Bunce","email":"test@gmail.com","message_type":"otp","subject":"Reset Password OTP","message":"This is a message from Bunce","phone_no":"+2349088798657"}',
}

(, )
  .then(() => .json())
  .then(() => .())
  .catch(() => .('error:' + ))

PHP

<?php

$client = new http\Client;
$request = new http\Client\Request;

$body = new http\Message\Body;
$body->append('{
    "sender_id": "Bunce",
    "email" : "test@gmail.com",
    "message_type" : "otp",
    "subject" : "Reset Password OTP",
    "message" : "This is a message from Bunce",
    "phone_no": "+2349088798657"
}');

$request->setRequestUrl('https://api.bunce.so/v1/messaging/transactional/send/sms');
$request->setRequestMethod('POST');
$request->setBody($body);

$request->setHeaders([
  'X-Authorization' => 'sk_live_************************',
  'Content-Type' => 'application/json'
]);

$client->enqueue($request)->send();
$response = $client->getResponse();

echo $response->getBody();

Java

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.bunce.so/v1/messaging/transactional/send/sms"))
    .header("X-Authorization", "sk_live_************************")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n    \"sender_id\": \"Bunce\",\n    \"email\" : \"test@gmail.com\",\n    \"message_type\" : \"otp\",\n    \"subject\" : \"Reset Password OTP\",\n    \"message\" : \"This is a message from Bunce\",\n    \"phone_no\": \"+2349088798657\"\n}"))
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response

{
  "success": true,
  "data": null,
  "message": "SMS message sent successfully"
}