We aim to provide comprehensive documentation, including API specifications, libraries, code samples for all the main languages, and details on the operation of services. We want to ensure you have whatever helps you make best use of our services.

If you have any questions about our services, please email support@melroselabs.com or submit a support request.

APIs

REST APIs that give you the power to communicate.

Voice

Inbound and outbound voice. Text-to-speech, speech-to-text and voice routing.

SMS

SMS API for sending, receiving and managing SMS.

Rich Messaging

Send messages to mobiles containing rich and interactive content.

Iridium

SMS and SBD with Iridium satellite phones.

Location

Lookup of IP addresses, mobile numbers and fixed-line numbers.

SMPP Bridge

Bridge between REST and SMPP for sending SMS.

Others: Compression, Notification Gateway, Identity

Get an API key for use with our voice, messaging, video and identity APIs.

SIGN-UP | LOGIN TO GET API KEY

Tools

Tools to help you test and integrate our APIs.

SMSC Simulator

SMPP SMSC simulator to test SMS messaging applications. Generate MO SMS using Inbound MO SMS Tool or SMPP.

Text-to-Speech Demo

TTS: Convert text to lifelike speech. Test voices using demo. Supports SSML.

Inbound Voice

SIP trunk and numbering for inbound voice to your PBX or application. Enable test voice calls from telephones to your application.

SMPP Implementation Testing

SMPP compliance and performance testing of SMSCs, SMS gateways and apps. Includes testing SMPP version support and performing load testing.

REST-SMPP Intelligent Bridge

Bridge between REST and SMPP for sending SMS. Useful in development and production for generating traffic.

SMPP Client

[Coming soon] SMPP client for testing with SMS gateways and SMSCs. Supports SMPP v3.3, v3.4 and v5.

Serverless

[Coming soon] Develop your code locally and then deploy to Melrose Labs for serverless execution to handle voice, video, messaging and identity.

Melrose Labs CLI

Melrose Labs command-line tool for use with our voice, messaging, video and identity APIs. (MelroseLabs-CLI on NPM)

Service Documentation

Our service documentation for developers provides indepth documentation on each of our services, including quickstart guides, tutorials, code samples, configuration examples and technical descriptions.

REST API documentation can be found at Rich Messaging API - Cards

Create a card using the Rich Messaging Cards service with the RESTful Rich Messaging API
Example using cURL, Node.js, Python, PHP

Create a card using a template and get URL of new card.

Request:

curl --location --request POST https://api.melroselabs.com/richmessaging/card/ \
	--header 'x-api-key: [API_KEY]' --header 'Content-Type: application/json' \
	--data-raw '{"templateref":"10","data":{"propertyname":"Santorini Escape","urlimage":"https://richmsg.io/media/images/seaview-apartments.png","propertysummary":"A luxurious two-bedroom apartment with the best views over Santorini.","urldetails":"https://melroselabs.com/services/rich-messaging/","urlbooknow":"https://melroselabs.com/services/rich-messaging/"},"userref":"","callback":"","expires":""}'

Response:

{ "messageID": "lpB", "shortURL": "https://richmsg.io/lpB" }

Request:

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://api.melroselabs.com/richmessaging/card/',
  'headers': {
    'x-api-key': '[API_KEY]',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({"templateref":"10","data":{"propertyname":"Santorini Escape","urlimage":"https://richmsg.io/media/images/seaview-apartments.png","propertysummary":"A luxurious two-bedroom apartment with the best views over Santorini.","urldetails":"https://melroselabs.com/services/rich-messaging/","urlbooknow":"https://melroselabs.com/services/rich-messaging/"},"userref":"","callback":"","expires":""})
};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body); // response is of type application/json
});

Response:

{ "messageID": "lpB", "shortURL": "https://richmsg.io/lpB" }

Request:

import requests
import json

url = "https://api.melroselabs.com/richmessaging/card/"
payload = {
	{"templateref":"10","data":{"propertyname":"Santorini Escape","urlimage":"https://richmsg.io/media/images/seaview-apartments.png","propertysummary":"A luxurious two-bedroom apartment with the best views over Santorini.","urldetails":"https://melroselabs.com/services/rich-messaging/","urlbooknow":"https://melroselabs.com/services/rich-messaging/"},"userref":"","callback":"","expires":""}
}
headers = {
  'x-api-key': '[API_KEY]',
  'Content-Type': 'application/json'
}

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

# response is of type application/json
print(response.text.encode('utf8'))

Response:

{ "messageID": "lpB", "shortURL": "https://richmsg.io/lpB" }

Request:

<?php 
$data = {"templateref":"10","data":{"propertyname":"Santorini Escape","urlimage":"https://richmsg.io/media/images/seaview-apartments.png","propertysummary":"A luxurious two-bedroom apartment with the best views over Santorini.","urldetails":"https://melroselabs.com/services/rich-messaging/","urlbooknow":"https://melroselabs.com/services/rich-messaging/"},"userref":"","callback":"","expires":""}

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.melroselabs.com/richmessaging/card/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => $data,
  CURLOPT_HTTPHEADER => array(
    "x-api-key: [API_KEY]",
    "Content-Type: application/json"
  )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response; // response is of type application/json
?>

Response:

{ "messageID": "lpB", "shortURL": "https://richmsg.io/lpB" }

The following card templates can be used with Rich Messaging API - Cards

Card Search
Template ID
10
[10.1]
Property Letting v1

Property lettings card used to promote a property.

The property letting card can be used to notify customers of properties that are being let. These could be for holiday lets. Use the action buttons to go to a website with more details and booking page. < less
more >
propertyname
Property name

Name of the property being let.

urlimage
Image URL

URL of the image to be displayed on the card. Image should be under 2MB.

propertysummary
Property summary

A brief description of the property.

urldetails
Details URL

URL of web page with more details on the property.

urlbooknow
Booking URL

URL of web page where property can be booked.

{
    "propertyname": "Santorini Escape",
    "urlimage": "https://richmsg.io/media/images/seaview-apartments.png",
    "propertysummary": "A luxurious two-bedroom apartment with the best views over Santorini.",
    "urldetails": "https://melroselabs.com/services/rich-messaging/",
    "urlbooknow": "https://melroselabs.com/services/rich-messaging/"
}
Template ID
11
[11.1]
Property for Sale v1

Property for sale card.

Use this card to advertise a property for sale to a potentially interested buyer. This card could be sent as a result of the potential buyer having registered interest in houses located in certain areas that meet specific criteria. < less
more >
status
Property status

Status of the property sale (e.g. FOR SALE).

propertyname
Property name

Name of the property being sold.

urlimage
Image URL

URL of image of the property.

price
Sale price

Sale price of property

propertysummary
Property summary

A brief description of the property.

propertydescription
Property description

A long description of the property.

urldetails
Details URL

URL of web page with more details on the property.

urlarrangeviewing
Booking URL

URL of web page where property viewing can be arranged.

{
    "status": "FOR SALE",
    "urlimage": "https://richmsg.io/media/images/propertyforsale.jpeg",
    "urlarrangeviewing": "https://abc.com",
    "urldetails": "https://abc.com",
    "propertyname": "Caldergrove Gardens, EH11",
    "price": "\u00a3292,000",
    "propertysummary": "3 bedrooms. New development.",
    "propertydescription": "Caldergrove Gardens is an innovative and stylish development of 55, 3, 4 & 5 bedroom detached homes, offering seven contemporary house styles. Show home open Thursday - Monday."
}
Template ID
12
[12.1]
Promotion v1

Promotion for use in retail by consumer.

Use the promotion card template to send promotions to customers that have signed-up to receive them from your organisation. Send a link to the card in an SMS text message, or other messaging channels, for customers to click on the link and display the card showing your promotion. When sending the link in an SMS text message, it is essential to ensure that the text accompanying the link is engaging and encourages customers to click on the link. < less
more >
urllogo
Logo URL

URL of the logo to be displayed on the card. Image should be under 2MB.

promotitle
Promotion title

Title of the promotion.

subtitle
Subtitle

Subtitle of the promotion.

urlimage
Image URL

URL of the image to be displayed on the card. Image should be under 2MB.

details
Details of promotion

A brief description of the promotion.

actiontext
Action text

Text on button that user clicks to order, book or find out more.

urlaction
Action URL

URL of web page where user can order, book or find out more.

additionaltext
Additional text

Any additional details regarding the promotion.

{
    "urllogo": "https://richmsg.io/media/images/pizza-logo.png",
    "promotitle": "Pizza Tuesday",
    "subtitle": "Buy one and get one free!",
    "urlimage": "https://richmsg.io/media/images/pizza.jpeg",
    "details": "When you order one large pizza on Tuesdays, we will give you another large pizza of your choice for free. Terms and conditions apply.",
    "actiontext": "Order Now",
    "urlaction": "https://abc.com",
    "additionaltext": "Terms and Conditions Apply"
}
Template ID
13
[13.1]
Ticket v1

Ticket card for an event.

event
Event name

Name of the event for the ticket.

subtitle
Subtitle

Subtitle of the event for the ticket.

urlimage
Image URL

URL of the image to be displayed on the ticket.

datetime
Event date and time

Date and time of the event.

venue
Venue

Where the event is taking place.

seat
Seat

Seat allocated to this ticket.

instructions
Instructions

Instructions associated with ticket and event.

{
    "event": "Strictly Dancing",
    "subtitle": "Christmas Tour",
    "urlimage": "https://melroselabs.com/phpqrcode/qrimg.php?qr=abc",
    "datetime": "23 Jan 2020, 7pm",
    "venue": "Dome, Glasgow, G1 1AB",
    "instructions": "Arrive 30 minutes prior to the performance for security checks.",
    "seat": "Q32",
    "urlaction": "https://abc.com"
}
Template ID
14
[14.1]
Coupon v1

Coupon card for use in retail with consumers.

Use this card template to create cards to give customers a coupon that can be used for discounts or other benefits. The coupon will generate a QR code from the coupon number. < less
more >
logo
Logo URL

URL of the logo image to be displayed on the coupon.

coupontitle
Coupon title

Title to show on the coupon.

subtitle
Subtitle

Subtitle of the coupon.

couponnumber
Coupon number

Text showing coupon number. Can contain letters and numbers.

validuntildatetime
Validity date and time

Date and time the the coupon is valid until.

validlocations
Valid locations

Locations at which the coupon is valid.

details
Details

Details on the use of this coupon for the holder of the coupon.

{
    "logo": "https://richmsg.io/media/images/sf-logo.png",
    "coupontitle": "Sainsfield Coupon",
    "subtitle": "Use this coupon to receive 5% discount on your next shop!",
    "couponnumber": "9823782738213",
    "validuntildatetime": "23 Jan 2020, 7pm",
    "validlocations": "All UK stores",
    "details": "Show this coupon when you go to the checkout to receive your discount."
}
Template ID
15
[15.1]
Restaurant booking v1

Card template to encourage customers to make reservations.

Use this card template to create cards to send to customers to encourage them to make a reservation in one of the upcoming available time slots. Will also keep a restaurant in the mind of the customer to increase recall and likelihood of booking at a later date, even when they are not looking to book one of the timeslots. < less
more >
topImage
Image URL

URL of the image to be displayed.

restaurantName
Restaurant name

Name of restaurant.

ratingValue
Rating value

Average rating from reviewers

reviewCount
Review count

Number of reviews

message
Message

Message to show encouraging patron to book.

timeWhenAvailability
When available title

Title showing when times are available (e.g. "Tonight's availability")

timeSlotA
Timeslot A

Time for slot (e.g. "5:00")

timeSlotB
Timeslot B

Time for slot (e.g. "5:00")

timeSlotC
Timeslot C

Time for slot (e.g. "5:00")

timeSlotD
Timeslot D

Time for slot (e.g. "5:00")

timeSlotE
Timeslot E

Time for slot (e.g. "5:00")

timeSlotF
Timeslot F

Time for slot (e.g. "5:00")

urlActionA
Action A URL

Website link (URL) that user is taken to when they click on the button for this time slot.

urlActionB
Action B URL

Website link (URL) that user is taken to when they click on the button for this time slot.

urlActionC
Action C URL

Website link (URL) that user is taken to when they click on the button for this time slot.

urlActionD
Action D URL

Website link (URL) that user is taken to when they click on the button for this time slot.

urlActionE
Action E URL

Website link (URL) that user is taken to when they click on the button for this time slot.

urlActionF
Action F URL

Website link (URL) that user is taken to when they click on the button for this time slot.

{
    "restaurantName": "Benedicts restaurant",
    "topImage": "https://richmsg.io/media/images/restaurant-burger-meal.jpg",
    "ratingValue": 4.5,
    "reviewCount": 319,
    "message": "We're open tonight and all burger meals have 10% discount. Book a table before they go!",
    "timeWhenAvailability": "Tonight's availability",
    "timeSlotA": "5:30",
    "urlActionA": "https://abc.com/A",
    "timeSlotB": "7:30",
    "urlActionB": "https://abc.com/B",
    "timeSlotC": "8:00",
    "urlActionC": "https://abc.com/C",
    "timeSlotD": "8.30",
    "urlActionD": "https://abc.com/D",
    "timeSlotE": "9:00",
    "urlActionE": "https://abc.com/E",
    "timeSlotF": "other",
    "urlActionF": "https://abc.com/F"
}
Create a message using Notification Gateway service with the REST API
Example using cURL, Node.js, Python, PHP

Create a message for delivery and get transaction ID for submission.

JSON request:

{
    "account": {
        "accountid": "abcd-abcd0123-abcd"
    },
    "message": {
        "variants": [
            {
                "channel": "twitter",
                "content": [
                    {
                        "ctype": "text",
                        "cdata": "Nicola Sturgeon says she will not hesitate to use the law to enforce group sizes and travel distances after traffic around beauty spots and a five-fold rise in police dispersal orders is seen."
                    },
                    {
                        "ctype": "image",
                        "cdata": "https://blogs.gov.scot/fairer-scotland/wp-content/uploads/sites/32/2017/04/22847857088_b1c3f67f4a_z.jpg"
                    }
                ]
            },
            {
                "channel": "sms",
                "content": [
                    {
                        "ctype": "text",
                        "cdata": "Nicola Sturgeon says she will not hesitate to use the law to enforce group sizes and travel distances after traffic around beauty spots and a five-fold rise in police dispersal orders is seen."
                    }
                ]
            },
            {
                "channel": "mms",
                "content": [
                    {
                        "ctype": "text",
                        "cdata": "Nicola Sturgeon says she will not hesitate to use the law to enforce group sizes and travel distances after traffic around beauty spots and a five-fold rise in police dispersal orders is seen."
                    },
                    {
                        "ctype": "image",
                        "cdata": "https://blogs.gov.scot/fairer-scotland/wp-content/uploads/sites/32/2017/04/22847857088_b1c3f67f4a_z.jpg"
                    }
                ]
            }
        ]
    },
    "recipients": [
        "twitter:melroselabs",
        "sms:+447968847040",
        "mms:+447720334455"
    ]
}

Request:

curl --location --request POST https://api.melroselabs.com/notification/ \
	--header 'x-api-key: [API_KEY]' --header 'Content-Type: application/json' \
	--data-raw '{"account":{"accountid":"abcd-abcd0123-abcd"},"message":{"variants":[{"channel":"twitter","content":[{"ctype":"text","cdata":"Nicola Sturgeon says she will not hesitate to use the law to enforce group sizes and travel distances after traffic around beauty spots and a five-fold rise in police dispersal orders is seen."},{"ctype":"image","cdata":"https://blogs.gov.scot/fairer-scotland/wp-content/uploads/sites/32/2017/04/22847857088_b1c3f67f4a_z.jpg"}]},{"channel":"sms","content":[{"ctype":"text","cdata":"Nicola Sturgeon says she will not hesitate to use the law to enforce group sizes and travel distances after traffic around beauty spots and a five-fold rise in police dispersal orders is seen."}]},{"channel":"mms","content":[{"ctype":"text","cdata":"Nicola Sturgeon says she will not hesitate to use the law to enforce group sizes and travel distances after traffic around beauty spots and a five-fold rise in police dispersal orders is seen."},{"ctype":"image","cdata":"https://blogs.gov.scot/fairer-scotland/wp-content/uploads/sites/32/2017/04/22847857088_b1c3f67f4a_z.jpg"}]}]},"recipients":["twitter:melroselabs","sms:+447968847040","mms:+447720334455"]}'

Response:

{ "transactionID": "41123b82-9f43-4ff8-8c01-0b4ce2bced6f" }

Request:

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://api.melroselabs.com/notification/',
  'headers': {
    'x-api-key': '[API_KEY]',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({"account":{"accountid":"abcd-abcd0123-abcd"},"message":{"variants":[{"channel":"twitter","content":[{"ctype":"text","cdata":"Nicola Sturgeon says she will not hesitate to use the law to enforce group sizes and travel distances after traffic around beauty spots and a five-fold rise in police dispersal orders is seen."},{"ctype":"image","cdata":"https://blogs.gov.scot/fairer-scotland/wp-content/uploads/sites/32/2017/04/22847857088_b1c3f67f4a_z.jpg"}]},{"channel":"sms","content":[{"ctype":"text","cdata":"Nicola Sturgeon says she will not hesitate to use the law to enforce group sizes and travel distances after traffic around beauty spots and a five-fold rise in police dispersal orders is seen."}]},{"channel":"mms","content":[{"ctype":"text","cdata":"Nicola Sturgeon says she will not hesitate to use the law to enforce group sizes and travel distances after traffic around beauty spots and a five-fold rise in police dispersal orders is seen."},{"ctype":"image","cdata":"https://blogs.gov.scot/fairer-scotland/wp-content/uploads/sites/32/2017/04/22847857088_b1c3f67f4a_z.jpg"}]}]},"recipients":["twitter:melroselabs","sms:+447968847040","mms:+447720334455"]})
};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body); // response is of type application/json
});

Response:

{ "transactionID": "41123b82-9f43-4ff8-8c01-0b4ce2bced6f" }

Request:

import requests
import json

url = "https://api.melroselabs.com/notification/"
payload = {
	{"account":{"accountid":"abcd-abcd0123-abcd"},"message":{"variants":[{"channel":"twitter","content":[{"ctype":"text","cdata":"Nicola Sturgeon says she will not hesitate to use the law to enforce group sizes and travel distances after traffic around beauty spots and a five-fold rise in police dispersal orders is seen."},{"ctype":"image","cdata":"https://blogs.gov.scot/fairer-scotland/wp-content/uploads/sites/32/2017/04/22847857088_b1c3f67f4a_z.jpg"}]},{"channel":"sms","content":[{"ctype":"text","cdata":"Nicola Sturgeon says she will not hesitate to use the law to enforce group sizes and travel distances after traffic around beauty spots and a five-fold rise in police dispersal orders is seen."}]},{"channel":"mms","content":[{"ctype":"text","cdata":"Nicola Sturgeon says she will not hesitate to use the law to enforce group sizes and travel distances after traffic around beauty spots and a five-fold rise in police dispersal orders is seen."},{"ctype":"image","cdata":"https://blogs.gov.scot/fairer-scotland/wp-content/uploads/sites/32/2017/04/22847857088_b1c3f67f4a_z.jpg"}]}]},"recipients":["twitter:melroselabs","sms:+447968847040","mms:+447720334455"]}
}
headers = {
  'x-api-key': '[API_KEY]',
  'Content-Type': 'application/json'
}

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

# response is of type application/json
print(response.text.encode('utf8'))

Response:

{ "transactionID": "41123b82-9f43-4ff8-8c01-0b4ce2bced6f" }

Request:

<?php 
$data = {"account":{"accountid":"abcd-abcd0123-abcd"},"message":{"variants":[{"channel":"twitter","content":[{"ctype":"text","cdata":"Nicola Sturgeon says she will not hesitate to use the law to enforce group sizes and travel distances after traffic around beauty spots and a five-fold rise in police dispersal orders is seen."},{"ctype":"image","cdata":"https://blogs.gov.scot/fairer-scotland/wp-content/uploads/sites/32/2017/04/22847857088_b1c3f67f4a_z.jpg"}]},{"channel":"sms","content":[{"ctype":"text","cdata":"Nicola Sturgeon says she will not hesitate to use the law to enforce group sizes and travel distances after traffic around beauty spots and a five-fold rise in police dispersal orders is seen."}]},{"channel":"mms","content":[{"ctype":"text","cdata":"Nicola Sturgeon says she will not hesitate to use the law to enforce group sizes and travel distances after traffic around beauty spots and a five-fold rise in police dispersal orders is seen."},{"ctype":"image","cdata":"https://blogs.gov.scot/fairer-scotland/wp-content/uploads/sites/32/2017/04/22847857088_b1c3f67f4a_z.jpg"}]}]},"recipients":["twitter:melroselabs","sms:+447968847040","mms:+447720334455"]}

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.melroselabs.com/notification/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => $data,
  CURLOPT_HTTPHEADER => array(
    "x-api-key: [API_KEY]",
    "Content-Type: application/json"
  )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response; // response is of type application/json
?>

Response:

{ "transactionID": "41123b82-9f43-4ff8-8c01-0b4ce2bced6f" }
Submitting a message to REST-SMPP Intelligent Bridge service with the REST API
Example using cURL, Node.js, Python, PHP

Submit message for delivery and get transaction ID for submission. This request submits a message for delivery to three mobile numbers (up to 250,000 mobile numbers can be submitted in one request). The submit window size is set to 10 messages and the number of binds that will be used is set to 1.

This request will result in:

  • The service returning a transaction ID for this request, along with a message ID for each destination mobile number that will be sent the message.
  • A single transceiver (TRX) bind being established by the worker process to smpp.sms.melroselabs.com:8775 using a TLS connection.
  • Three submit_sm PDUs being sent, and then receiving the corresponding submit_sm_resp PDUs.
  • Delivery receipts being received by the worker process for each of the three messages once they reach completion (e.g. delivered or undelivered).

JSON request:

{
    "smpp_account_config": {
        "host": "smpp.sms.melroselabs.com",
        "port": 8775,
        "use_tls": true,
        "smpp_version": 5,
        "system_id": "SYSTEMID",
        "password": "PASSWORD"
    },
    "submit_options": {
        "windowSizeSubmitSM": 10,
        "quantityBindSessions": 1
    },
    "message": {
        "source_addr": "MelroseLabs",
        "source_addr_ton": 5,
        "source_addr_npi": 0,
        "registered_delivery": 1,
        "short_message": {
            "text": "Melrose Labs engineer great communication services."
        }
    },
    "destinations": [
        "447968847040",
        "15005552361",
        "390611100000"
    ]
}

Request:

curl --location --request POST https://api.melroselabs.com/restsmpp/message/ \
	--header 'x-api-key: [API_KEY]' --header 'Content-Type: application/json' \
	--data-raw '{"smpp_account_config":{"host":"smpp.sms.melroselabs.com","port":8775,"use_tls":true,"smpp_version":5,"system_id":"SYSTEMID","password":"PASSWORD"},"submit_options":{"windowSizeSubmitSM":10,"quantityBindSessions":1},"message":{"source_addr":"MelroseLabs","source_addr_ton":5,"source_addr_npi":0,"registered_delivery":1,"short_message":{"text":"Melrose Labs engineer great communication services."}},"destinations":["447968847040","15005552361","390611100000"]}'

Response:

{ "transactionID": "41123b82-9f43-4ff8-8c01-0b4ce2bced6f", "messageID":["abcd0001","abcd0002","abcd0003"] }

Request:

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://api.melroselabs.com/restsmpp/message/',
  'headers': {
    'x-api-key': '[API_KEY]',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({"smpp_account_config":{"host":"smpp.sms.melroselabs.com","port":8775,"use_tls":true,"smpp_version":5,"system_id":"SYSTEMID","password":"PASSWORD"},"submit_options":{"windowSizeSubmitSM":10,"quantityBindSessions":1},"message":{"source_addr":"MelroseLabs","source_addr_ton":5,"source_addr_npi":0,"registered_delivery":1,"short_message":{"text":"Melrose Labs engineer great communication services."}},"destinations":["447968847040","15005552361","390611100000"]})
};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body); // response is of type application/json
});

Response:

{ "transactionID": "41123b82-9f43-4ff8-8c01-0b4ce2bced6f", "messageID":["abcd0001","abcd0002","abcd0003"] }

Request:

import requests
import json

url = "https://api.melroselabs.com/restsmpp/message/"
payload = {
	{"smpp_account_config":{"host":"smpp.sms.melroselabs.com","port":8775,"use_tls":true,"smpp_version":5,"system_id":"SYSTEMID","password":"PASSWORD"},"submit_options":{"windowSizeSubmitSM":10,"quantityBindSessions":1},"message":{"source_addr":"MelroseLabs","source_addr_ton":5,"source_addr_npi":0,"registered_delivery":1,"short_message":{"text":"Melrose Labs engineer great communication services."}},"destinations":["447968847040","15005552361","390611100000"]}
}
headers = {
  'x-api-key': '[API_KEY]',
  'Content-Type': 'application/json'
}

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

# response is of type application/json
print(response.text.encode('utf8'))

Response:

{ "transactionID": "41123b82-9f43-4ff8-8c01-0b4ce2bced6f", "messageID":["abcd0001","abcd0002","abcd0003"] }

Request:

<?php 
$data = {"smpp_account_config":{"host":"smpp.sms.melroselabs.com","port":8775,"use_tls":true,"smpp_version":5,"system_id":"SYSTEMID","password":"PASSWORD"},"submit_options":{"windowSizeSubmitSM":10,"quantityBindSessions":1},"message":{"source_addr":"MelroseLabs","source_addr_ton":5,"source_addr_npi":0,"registered_delivery":1,"short_message":{"text":"Melrose Labs engineer great communication services."}},"destinations":["447968847040","15005552361","390611100000"]}

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.melroselabs.com/restsmpp/message/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => $data,
  CURLOPT_HTTPHEADER => array(
    "x-api-key: [API_KEY]",
    "Content-Type: application/json"
  )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response; // response is of type application/json
?>

Response:

{ "transactionID": "41123b82-9f43-4ff8-8c01-0b4ce2bced6f", "messageID":["abcd0001","abcd0002","abcd0003"] }

REST API documentation can be found at Voice API - Text-to-Speech

Convert text to speech using the Voice Gateway Text-to-Speech service with RESTful Voice API
Example using cURL, Node.js, Python and PHP

Submit conversion request and retrieve resulting speech.

Request:

curl --location --request POST https://api.melroselabs.com/voice/tts/ \
	--header 'x-api-key: [API_KEY]' --header 'Content-Type: application/json' \
	--data-raw '{"voiceText": "Welcome Allan. The event for today will begin at 9.30am in room H32.", "voice": "Emma"}'

Response:

MP3 file

Request:

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://api.melroselabs.com/voice/tts/',
  'headers': {
    'x-api-key': '[API_KEY]',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({"voiceText": "Welcome Allan. The event for today will begin at 9.30am in room H32.", "voice": "Emma"})
};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body); // response is of type audio/mp3
});

Response:

MP3 file

Request:

import requests
import json

url = "https://api.melroselabs.com/voice/tts/"
payload = {
	{"voiceText": "Welcome Allan. The event for today will begin at 9.30am in room H32.", "voice": "Emma"}
}
headers = {
  'x-api-key': '[API_KEY]',
  'Content-Type': 'application/json'
}

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

# response is of type audio/mp3
print(response.content)

Response:

MP3 file

Request:

<?php 
$data = {"voiceText": "Welcome Allan. The event for today will begin at 9.30am in room H32.", "voice": "Emma"}

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.melroselabs.com/voice/tts/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => $data,
  CURLOPT_HTTPHEADER => array(
    "x-api-key: [API_KEY]",
    "Content-Type: application/json"
  )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response; // response is of type audio/mp3
?>

Response:

MP3 file

The asyncronous method is a two step process involving the submitting of the conversion request and then the retrieval of the result.

1. Submit conversion request.

Request:

curl --location --request POST https://api.melroselabs.com/voice/texttospeech/ \
	--header 'x-api-key: [API_KEY]' --header 'Content-Type: application/json' \
	--data-raw '{"voiceText": "Welcome Allan. The event for today will begin at 9.30am in room H32.", "voice": "Emma"}'

Response:

{"transactionID": "1ccead78-6550-4aac-a6b4-a4942b908659"}

Request:

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://api.melroselabs.com/voice/texttospeech/',
  'headers': {
    'x-api-key': '[API_KEY]',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({"voiceText": "Welcome Allan. The event for today will begin at 9.30am in room H32.", "voice": "Emma"})
};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body); // response is of type application/json
});

Response:

{"transactionID": "1ccead78-6550-4aac-a6b4-a4942b908659"}

Request:

import requests
import json

url = "https://api.melroselabs.com/voice/texttospeech/"
payload = {
	{"voiceText": "Welcome Allan. The event for today will begin at 9.30am in room H32.", "voice": "Emma"}
}
headers = {
  'x-api-key': '[API_KEY]',
  'Content-Type': 'application/json'
}

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

# response is of type application/json
print(response.text.encode('utf8'))

Response:

{"transactionID": "1ccead78-6550-4aac-a6b4-a4942b908659"}

Request:

<?php 
$data = {"voiceText": "Welcome Allan. The event for today will begin at 9.30am in room H32.", "voice": "Emma"}

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.melroselabs.com/voice/texttospeech/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => $data,
  CURLOPT_HTTPHEADER => array(
    "x-api-key: [API_KEY]",
    "Content-Type: application/json"
  )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response; // response is of type application/json
?>

Response:

{"transactionID": "1ccead78-6550-4aac-a6b4-a4942b908659"}

2. Retrieve resulting speech.

Request:

curl --location --request GET https://api.melroselabs.com/voice/texttospeech/1ccead78-6550-4aac-a6b4-a4942b908659 \
	--header 'x-api-key: [API_KEY]' 

Response:

MP3 file

Request:

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://api.melroselabs.com/voice/texttospeech/1ccead78-6550-4aac-a6b4-a4942b908659',
  'headers': {
    'x-api-key': '[API_KEY]'
  }
};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body); // response is of type audio/mp3
});

Response:

MP3 file

Request:

import requests
import json

url = "https://api.melroselabs.com/voice/texttospeech/1ccead78-6550-4aac-a6b4-a4942b908659"

headers = {
  'x-api-key': '[API_KEY]'
}

response = requests.request("GET", url, headers=headers)

# response is of type audio/mp3
print(response.content)

Response:

MP3 file

Request:

<?php 
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.melroselabs.com/voice/texttospeech/1ccead78-6550-4aac-a6b4-a4942b908659",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "x-api-key: [API_KEY]"  )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response; // response is of type audio/mp3
?>

Response:

MP3 file
Using Email to Access the Text-to-Speech Service

Email can be used to easily and quickly perform a text-to-speech (TTS) conversion as an alternative to using REST HTTPS calls to the Voice API. Send an email to the Text-to-Speech service at voice@api.melroselabs.com and use the subject field to contain the text you wish converted. After a number of seconds, you will receive an email back from the service with an MP3 file containing the converted speech.

Various voices and corresponding languages are available using email addresses specific to each voice. The format of each email address is voice.language.voice@api.melroselabs.com and the options for voice and language are shown in the list of available languages and voices.

An API key is currently not required when using email.

The following languages and voices are available using the Text-to-Speech service:

Language Voice Sample Email (example)
Arabic (arb)Zeina (f) zeina.arb.voice@api.melroselabs.com
Chinese, Mandarin (cmn-CN)Zhiyu (f) zhiyu.cmn-cn.voice@api.melroselabs.com
Danish (da-dk)Mads (m)
Naja (f)
mads.da-dk.voice@api.melroselabs.com
Dutch (nl-nl)Lotte (f)
Ruben (m)
lotte.nl-nl.voice@api.melroselabs.com
English, Australian (en-AU)Russell (m)
Nicole (f)
russell.en-au.voice@api.melroselabs.com
English (en-GB)²Emma (f)
Amy (f)
Brian (m)
emma.en-gb.voice@api.melroselabs.com
English, Indian (en-IN)Aditi (f)
Raveena (f)
aditi.en-in.voice@api.melroselabs.com
English (en-US)²Salli (f)¹
Ivy (f)
Joanna (f)
Kendra (f)
Kimberly (f)
Joey (m)
Justin (m)
Matthew (m)
salli.en-us.voice@api.melroselabs.com
English, Welsh (en-GB-WLS)Geraint (m) geraint.en-gb-wls.voice@api.melroselabs.com
French (fr-FR)Céline/Celine (f)
Léa/Lea (f)
Mathieu (m)
celine.fr-fr.voice@api.melroselabs.com
French, Canadian (fr-CA)Chantal (f) chantal.fr-ca.voice@api.melroselabs.com
Germany (de-DE)Vicki (f)
Marlene (f)
Hans (m)
vicki.de-de.voice@api.melroselabs.com
Hindi (hi-IN)Aditi (f) aditi.hi-in.voice@api.melroselabs.com
Icelandic (is-IS)Karl (m)
Dóra/Dora (f)
karl.is-is.voice@api.melroselabs.com
Italian (it-IT)Bianca (f)
Carla (f)
Giorgio (m)
bianca.it-it.voice@api.melroselabs.com
Japanese (ja-JP)Mizuki (f)
Takumi (m)
mizuki.ja-jp.voice@api.melroselabs.com
Korean (ko-KR)Seoyeon (f) seoyeon.ko-kr.voice@api.melroselabs.com
Norwegian (nb-NO)Liv (f) liv.nb-no.voice@api.melroselabs.com
Polish (pl-PL)Jan (m)
Ewa (f)
Maja (f)
Jacek (m)
jan.pl-pl.voice@api.melroselabs.com
Portuguese (pt-BR)Camila² (f)
Vitória/Vitoria (f)
Ricardo (m)
vitoria.pt-br.voice@api.melroselabs.com
Portuguese (pt-PT)Cristiano (m)
Inês/Ines (f)
cristiano.pt-pt.voice@api.melroselabs.com
Romanian (ro-RO)Carmen (f) carmen.ro-ro.voice@api.melroselabs.com
Russian (ru-RU)Tatyana (f)
Maxim (m)
tatyana.ru-ru.voice@api.melroselabs.com
Spanish (es-ES)Enrique (m)
Lucia (f)
Conchita (f)
enrique.es-es.voice@api.melroselabs.com
Spanish (es-MX)Mia (f) mia.es-mx.voice@api.melroselabs.com
Spanish (es-US)Lupe² (f)
Penélope/Penelope (f)
Miguel (m)
penelope.es-us.voice@api.melroselabs.com
Swedish (sv-SE)Astrid (f) astrid.sv-se.voice@api.melroselabs.com
Turkish (tr-TR)Filiz (f) filiz.tr-tr.voice@api.melroselabs.com
Welsh (cy-GB)Gwyneth (f) gwyneth.cy-gb.voice@api.melroselabs.com

¹ Default voice. Used for voice@api.melroselabs.com or when no voice is specified during a Voice API REST call.
² Will use neural engine unless standard engine is requested.

REST API documentation can be found at Voice API - Speech-to-Text

Convert speech to text using the Voice Gateway Speech-to-Text service with RESTful Voice API
Example using cURL, Node.js, Python and PHP

Submit conversion request.

Request:

curl --location --request POST https://api.melroselabs.com/voice/speechtotext/ \
	--header 'x-api-key: [API_KEY]' --header 'Content-Type: audio/mp3' \
	--data-binary 'MP3-FILE'

Response:

{"transactionID": "1ccead78-6550-4aac-a6b4-a4942b908659"}

Request:

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://api.melroselabs.com/voice/speechtotext/',
  'headers': {
    'x-api-key': '[API_KEY]',
    'Content-Type': 'audio/mp3'
  },
  body: JSON.stringify(MP3-FILE)
};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body); // response is of type application/json
});

Response:

{"transactionID": "1ccead78-6550-4aac-a6b4-a4942b908659"}

Request:

import requests
import json

url = "https://api.melroselabs.com/voice/speechtotext/"
payload = {
	MP3-FILE
}
headers = {
  'x-api-key': '[API_KEY]',
  'Content-Type': 'audio/mp3'
}

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

# response is of type application/json
print(response.text.encode('utf8'))

Response:

{"transactionID": "1ccead78-6550-4aac-a6b4-a4942b908659"}

Request:

<?php 
$data = array("name"=>"file","file"=>"@FILE")

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.melroselabs.com/voice/speechtotext/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_SAFE_UPLOAD => FALSE,
  CURLOPT_POSTFIELDS => $data,
  CURLOPT_HTTPHEADER => array(
    "x-api-key: [API_KEY]",
    "Content-Type: audio/mp3"
  )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response; // response is of type application/json
?>

Response:

{"transactionID": "1ccead78-6550-4aac-a6b4-a4942b908659"}

Retrieve text of speech.

Request:

curl --location --request GET https://api.melroselabs.com/voice/speechtotext/1ccead78-6550-4aac-a6b4-a4942b908659 \
	--header 'x-api-key: [API_KEY]' 

Response:

{"text": "Alice was beginning to get very tired of sitting by her sister on the bank and of having nothing to do."}

Request:

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://api.melroselabs.com/voice/speechtotext/1ccead78-6550-4aac-a6b4-a4942b908659',
  'headers': {
    'x-api-key': '[API_KEY]'
  }
};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body); // response is of type application/json
});

Response:

{"text": "Alice was beginning to get very tired of sitting by her sister on the bank and of having nothing to do."}

Request:

import requests
import json

url = "https://api.melroselabs.com/voice/speechtotext/1ccead78-6550-4aac-a6b4-a4942b908659"

headers = {
  'x-api-key': '[API_KEY]'
}

response = requests.request("GET", url, headers=headers)

# response is of type application/json
print(response.text.encode('utf8'))

Response:

{"text": "Alice was beginning to get very tired of sitting by her sister on the bank and of having nothing to do."}

Request:

<?php 
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.melroselabs.com/voice/speechtotext/1ccead78-6550-4aac-a6b4-a4942b908659",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "x-api-key: [API_KEY]"  )
));

$response = curl_exec($curl);

curl_close($curl);

echo $response; // response is of type application/json
?>

Response:

{"text": "Alice was beginning to get very tired of sitting by her sister on the bank and of having nothing to do."}

GitHub

Find Melrose Labs on GitHub