Transactional Messaging
The Transactional messaging API allows you create, send and manage transactional messaging on your integration.
Send Email
Post
https://api.bunce.so/v1/messaging/transactional/send/email
Send Email
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_email string<email> required | Sender Email |
sender_name string<email> required | Sender Name |
email string<email> required | Recipient Email |
message_type string required | Message Type |
subject string required | Message Subject |
text or html string required | Message Text or HTML Code |
customer_id string optional | Customer ID |
template_id string optional | Template ID |
email_template_id string optional | The email template ID, (not template ID). This is required in place of template_id, html and text properties not being set |
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 --request POST \
--url https://api.bunce.so/v1/messaging/transactional/send/email \
--header 'Content-Type: application/json' \
--header 'X-Authorization: sk_live_************************' \
--data '{
"sender_email": "john@example.com",
"sender_name": "John Doe",
"email" : "example@gmail.com",
"subject" : "Reset Password OTP",
"text" : "Your OTP is 0000"
}'
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "http://api.bunce.so/v1/messaging/transactional/send/email"
payload := strings.NewReader("{\n \"sender_email\": \"john@example.com\",\n \"sender_name\": \"John Doe\",\n \"email\" : \"example@gmail.com\",\n \"subject\" : \"Reset Password OTP\",\n \"text\" : \"Your OTP is 0000\"\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))
}
const = {
: 'POST',
: {
'X-Authorization': 'sk_live_************************',
'Content-Type': 'application/json',
},
: '{"sender_email":"john@example.com","sender_name":"John Doe","email":"example@gmail.com","subject":"Reset Password OTP","text":"Your OTP is 0000"}',
}
('https://api.bunce.so/v1/messaging/transactional/send/email', )
.(() => .())
.(() => .())
.(() => .())
<?php
$client = new http\Client;
$request = new http\Client\Request;
$body = new http\Message\Body;
$body->append('{
"sender_email": "john@example.com",
"sender_name": "John Doe",
"email" : "example@gmail.com",
"subject" : "Reset Password OTP",
"text" : "Your OTP is 0000"
}');
$request->setRequestUrl('https://api.bunce.so/v1/messaging/transactional/send/email');
$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();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.bunce.so/v1/messaging/transactional/send/email"))
.header("X-Authorization", "sk_live_************************")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"sender_email\": \"john@example.com\",\n \"sender_name\": \"John Doe\",\n \"email\" : \"example@gmail.com\",\n \"subject\" : \"Reset Password OTP\",\n \"text\" : \"Your OTP is 0000\"\n}"))
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Response
{
"success": true,
"data": null,
"message": "Email message sent successfully"
}