Using the Restcomm API, you can send Emails through a simple request.
Email resource URI
/2012-04-24/Accounts/{AccountSid}/Email/Messages
Send a new email and get email details
HTTP POST. Sends a new Email message and returns the representation of the Email message resource, including the properties above. Below you will find a list of required and optional parameters.
Request Parameters
Parameter
Description
From(Required)
The Email address to use as sender address.
To(Required)
The destination Email address.
Body(Required)
The body of the Email message.
Subject(Required)
The subject of the Email message.(Max. 160 chars.)
Type
The value to be used in the Content-Type header of the email message. (eg text/html for HTML emails)
BCC
The Blind Carbon Copy feature (Bcc). (Hide addresses when sending an Email to various recipients)
CC
The Carbon Copy (Cc). (The list of CCed recipients is visible to all other recipients of the message.)
Examples
curl -X POST https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/ACCOUNT_SID/Email/Messages \
-d 'To=john.doe@yourcompany.com' \
-d 'From=jane.doe@yourcompany.com' \
-d 'Body=This is a test' \
-d 'Subject=Test Email' \
-u 'YourAccountSid:YourAuthToken'
const request = require('request');
// Provide your Account Sid and Auth Token from your Console Account page
const ACCOUNT_SID = 'my_ACCOUNT_SID';
const AUTH_TOKEN = 'my_AUTH_TOKEN';
request.({
method: 'POST',
url: 'https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/' + ACCOUNT_SID + '/Email/Messages',
auth: { 'user': ACCOUNT_SID, 'pass': AUTH_TOKEN },
form: {
'To': 'john.doe@yourcompany.com',
'From': 'jane.doe@yourcompany.com',
'Body': 'This is a test',
'Subject': 'Test Email'
}
},
function (error, response, body) {
// Add your business logic below; status can be found at 'response.statusCode' and response body at 'body'
...
});
from http.client import HTTPSConnection
from base64 import b64encode
from urllib.parse import urlencode
# Provide your Account Sid and Auth Token from your Console Account page
ACCOUNT_SID = 'my_ACCOUNT_SID'
AUTH_TOKEN = 'my_AUTH_TOKEN'
userAndPass = b64encode(bytes(ACCOUNT_SID + ':' + AUTH_TOKEN, 'utf-8')).decode("ascii")
headers = { 'Authorization' : 'Basic %s' % userAndPass,
'Content-type': 'application/x-www-form-urlencoded',
'Accept': 'text/plain' }
# Update POST parameters accordingly
params = urlencode({
'To': 'john.doe@yourcompany.com',
'From': 'jane.doe@yourcompany.com',
'Body': 'This is a test',
'Subject': 'Test Email'
})
conn = HTTPSConnection('mycompany.restcomm.com')
conn.request("POST", '/restcomm/2012-04-24/Accounts/' + ACCOUNT_SID + '/Email/Messages',
params, headers=headers)
res = conn.getresponse()
# Add your business logic below; status can be found at 'res.status', reason at 'res.reason' and response body can be retrieved with res.read()
...
import java.net.URL;
import javax.net.ssl.HttpsURLConnection;
import java.io.*;
import java.util.Base64;
public class JavaSampleClass {
// Provide your Account Sid and Auth Token from your Console Account page
public static final String ACCOUNT_SID = "my_ACCOUNT_SID";
public static final String AUTH_TOKEN = "my_AUTH_TOKEN";
public static void main(String[] args) throws Exception {
String userAndPass = ACCOUNT_SID + ':' + AUTH_TOKEN;
String encoded = Base64.getEncoder().encodeToString(userAndPass.getBytes());
URL url = new URL(("https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/" + ACCOUNT_SID + "/Email/Messages");
HttpsURLConnection conn = (HttpsURLConnection)url.openConnection();
conn.setRequestProperty("Authorization", "Basic " + encoded);
conn.setRequestMethod("POST");
conn.setDoOutput(true);
DataOutputStream os = new DataOutputStream(conn.getOutputStream());
// Update POST parameters accordingly
os.writeBytes("To=john.doe@yourcompany.com&" +
"From=jane.doe@yourcompany.com&" +
"Body=This is a test&" +
"Subject=Test Email");
os.close();
// Add your business logic below; response code can be obtained from 'conn.getResponseCode()' and input stream from 'conn.getInputStream()'
...
}
}
Using Email
Example POST Response - XML and JSON
XML POST Response
curl -X POST https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/ACCOUNT_SID/Email/Messages \
-d 'To=john.doe@yourcompany.com' \
-d 'From=jane.doe@yourcompany.com' \
-d 'Body=This is a test' \
-d 'Subject=Test Email' \
-u 'YourAccountSid:YourAuthToken'
const request = require('request');
// Provide your Account Sid and Auth Token from your Console Account page
const ACCOUNT_SID = 'my_ACCOUNT_SID';
const AUTH_TOKEN = 'my_AUTH_TOKEN';
request.({
method: 'POST',
url: 'https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/' + ACCOUNT_SID + '/Email/Messages',
auth: { 'user': ACCOUNT_SID, 'pass': AUTH_TOKEN },
form: {
'To': 'john.doe@yourcompany.com',
'From': 'jane.doe@yourcompany.com',
'Body': 'This is a test',
'Subject': 'Test Email'
}
},
function (error, response, body) {
// Add your business logic below; status can be found at 'response.statusCode' and response body at 'body'
...
});
from http.client import HTTPSConnection
from base64 import b64encode
from urllib.parse import urlencode
# Provide your Account Sid and Auth Token from your Console Account page
ACCOUNT_SID = 'my_ACCOUNT_SID'
AUTH_TOKEN = 'my_AUTH_TOKEN'
userAndPass = b64encode(bytes(ACCOUNT_SID + ':' + AUTH_TOKEN, 'utf-8')).decode("ascii")
headers = { 'Authorization' : 'Basic %s' % userAndPass,
'Content-type': 'application/x-www-form-urlencoded',
'Accept': 'text/plain' }
# Update POST parameters accordingly
params = urlencode({
'To': 'john.doe@yourcompany.com',
'From': 'jane.doe@yourcompany.com',
'Body': 'This is a test',
'Subject': 'Test Email'
})
conn = HTTPSConnection('mycompany.restcomm.com')
conn.request("POST", '/restcomm/2012-04-24/Accounts/' + ACCOUNT_SID + '/Email/Messages',
params, headers=headers)
res = conn.getresponse()
# Add your business logic below; status can be found at 'res.status', reason at 'res.reason' and response body can be retrieved with res.read()
...
import java.net.URL;
import javax.net.ssl.HttpsURLConnection;
import java.io.*;
import java.util.Base64;
public class JavaSampleClass {
// Provide your Account Sid and Auth Token from your Console Account page
public static final String ACCOUNT_SID = "my_ACCOUNT_SID";
public static final String AUTH_TOKEN = "my_AUTH_TOKEN";
public static void main(String[] args) throws Exception {
String userAndPass = ACCOUNT_SID + ':' + AUTH_TOKEN;
String encoded = Base64.getEncoder().encodeToString(userAndPass.getBytes());
URL url = new URL(("https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/" + ACCOUNT_SID + "/Email/Messages");
HttpsURLConnection conn = (HttpsURLConnection)url.openConnection();
conn.setRequestProperty("Authorization", "Basic " + encoded);
conn.setRequestMethod("POST");
conn.setDoOutput(true);
DataOutputStream os = new DataOutputStream(conn.getOutputStream());
// Update POST parameters accordingly
os.writeBytes("To=john.doe@yourcompany.com&" +
"From=jane.doe@yourcompany.com&" +
"Body=This is a test&" +
"Subject=Test Email");
os.close();
// Add your business logic below; response code can be obtained from 'conn.getResponseCode()' and input stream from 'conn.getInputStream()'
...
}
}
<RestcommResponse>
<EmailMessage>
<DateSent>2016-02-07T23:43:03.910Z</DateSent>
<AccountSid>ACae6e420f425248d6a26948c17a9e2acf</AccountSid>
<From>jane.doe@yourcompany.com</From>
<To>john.doe@yourcompany.com</To>
<Body>This is a test</Body>
<Subject>Test Email</Subject>
</EmailMessage>
JSON POST Response
curl -X POST https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/ACCOUNT_SID/Email/Messages \
-d 'To=john.doe@yourcompany.com' \
-d 'From=jane.doe@yourcompany.com' \
-d 'Body=This is a test ' \
-d 'Subject=Test Email' \
-u 'YourAccountSid:YourAuthToken'
const request = require('request');
// Provide your Account Sid and Auth Token from your Console Account page
const ACCOUNT_SID = 'my_ACCOUNT_SID';
const AUTH_TOKEN = 'my_AUTH_TOKEN';
request.({
method: 'POST',
url: 'https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/' + ACCOUNT_SID + '/Email/Messages',
auth: { 'user': ACCOUNT_SID, 'pass': AUTH_TOKEN },
form: {
'To': 'john.doe@yourcompany.com',
'From': 'jane.doe@yourcompany.com',
'Body': 'This is a test ',
'Subject': 'Test Email'
}
},
function (error, response, body) {
// Add your business logic below; status can be found at 'response.statusCode' and response body at 'body'
...
});
from http.client import HTTPSConnection
from base64 import b64encode
from urllib.parse import urlencode
# Provide your Account Sid and Auth Token from your Console Account page
ACCOUNT_SID = 'my_ACCOUNT_SID'
AUTH_TOKEN = 'my_AUTH_TOKEN'
userAndPass = b64encode(bytes(ACCOUNT_SID + ':' + AUTH_TOKEN, 'utf-8')).decode("ascii")
headers = { 'Authorization' : 'Basic %s' % userAndPass,
'Content-type': 'application/x-www-form-urlencoded',
'Accept': 'text/plain' }
# Update POST parameters accordingly
params = urlencode({
'To': 'john.doe@yourcompany.com',
'From': 'jane.doe@yourcompany.com',
'Body': 'This is a test ',
'Subject': 'Test Email'
})
conn = HTTPSConnection('mycompany.restcomm.com')
conn.request("POST", '/restcomm/2012-04-24/Accounts/' + ACCOUNT_SID + '/Email/Messages',
params, headers=headers)
res = conn.getresponse()
# Add your business logic below; status can be found at 'res.status', reason at 'res.reason' and response body can be retrieved with res.read()
...
import java.net.URL;
import javax.net.ssl.HttpsURLConnection;
import java.io.*;
import java.util.Base64;
public class JavaSampleClass {
// Provide your Account Sid and Auth Token from your Console Account page
public static final String ACCOUNT_SID = "my_ACCOUNT_SID";
public static final String AUTH_TOKEN = "my_AUTH_TOKEN";
public static void main(String[] args) throws Exception {
String userAndPass = ACCOUNT_SID + ':' + AUTH_TOKEN;
String encoded = Base64.getEncoder().encodeToString(userAndPass.getBytes());
URL url = new URL(("https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/" + ACCOUNT_SID + "/Email/Messages");
HttpsURLConnection conn = (HttpsURLConnection)url.openConnection();
conn.setRequestProperty("Authorization", "Basic " + encoded);
conn.setRequestMethod("POST");
conn.setDoOutput(true);
DataOutputStream os = new DataOutputStream(conn.getOutputStream());
// Update POST parameters accordingly
os.writeBytes("To=john.doe@yourcompany.com&" +
"From=jane.doe@yourcompany.com&" +
"Body=This is a test &" +
"Subject=Test Email");
os.close();
// Add your business logic below; response code can be obtained from 'conn.getResponseCode()' and input stream from 'conn.getInputStream()'
...
}
}
{
"date_sent": "2016-02-07T23:54:41.293Z",
"account_sid": "ACae6e420f425248d6a26948c17a9e2acf",
"from": "jane.doe@yourcompany.com",
"to": "john.doe@yourcompany.com",
"body": "This is a test",
"subject": "Test Email"
}
Email Attributes
Attribute
Description
DateSent
The date that this Email Message was send.
AccountSid
The unique id of the Account that sent this Email message.