Conference Campaign Solo Rich Messaging

Support

If you have any questions about your service from us, please email support@melroselabs.com or use our support request form. API documentation and other helpful documentation can be found below.


APIs

Documentation for the Melrose Labs APIs.

Voice API

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

SMS API

SMS API for sending, receiving and managing SMS.

Rich Messaging API

Send messages to mobiles containing rich and interactive content.

Ticketing API

Create and manage tickets and coupons.

Iridium API

SMS and SBD with Iridium satellite phones.

Compression API

Compression and decompression of data.

Location API

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

Support request

Please provide your first name.
Please provide your last name.
Please provide a valid company name.
Please provide a valid email address.
Please type your support request.
 

Documentation

Our service Documentation section 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
Examples using cURL, NodeJS, Python

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/"
	}
}'

Response:

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

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

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:

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

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

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/"
	}
}
headers = {
  'x-api-key': '[API_KEY]',
  'Content-Type': 'application/json'
}

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

print(response.text.encode('utf8'))

Response:

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

Quickstart

The account details email that you receive when you sign-up for CloudPBX contains all account information that is usually required for you to start using your new CloudPBX account. Each user's extension details (i.e. extension number, user ID, extension password, voicemail password and domain) are included in this email. Once entered into the user's softphone or desk phone, the extension should register with your CloudPBX instance and be able to make and receive calls.

Voicemail

To access your voicemail from your phone, dial *98.

Outbound calling

For new CloudPBX instances that will have been set-up on the Basic package, outbound calling to the public phone network is not available. We can upgrade your account if you require, however, please note that this process may take a few days to complete. In the meantime, you can familiarise yourself with the features of your new CloudPBX phone system.

Auto Attendant

When callers dial your main telephone number they will hear your Auto Attendant. This will annouce your company and present the caller with options to get through to your team. If you wish to check what callers hear, then you can do so by dialing extention 5000 from any of your CloudPBX extensions.

If you wish to modify your Auto Attendant, please contact Support with the changes you wish to make.

Conferencing

CloudPBX supports conference calling between members of your team. Different levels of call quality are available depending on the conference room used. There are 300 conference rooms available with your CloudPBX instance and participants simply dial the room number to join the conference.

Conference QualityBandwidthConference Room Extension
LowNarrowband3000 - 3099
MediumWideband3100 - 3199
HighUltrawideband3200 - 3299

The conferencing facility included in CloudPBX does not support particpants calling into conference calls from other landlines and mobiles. If you wish to conduct a conference call that includes external participants, then please take a look at our Conference service.

Extensions

To add or remove extensions, please contact Support with the changes you wish to make.

Inbound Numbering

When your CloudPBX account instance was created, a telephone number was automatically allocated to your instance as the main number for reaching your organisation ("Your CloudPBX telephone number"). This number can be changed to a number from the Melrose Labs Inbound Voice service or to a number associated with a SIP trunk that you provide. If you wish to make either of these changes, please contact Support who will assist you.

Quickstart

The account details email that you receive when you sign-up for Conference contains all account information that is usually required for you to start using your new Conference account. Simply distribute your Conference telephone number and/or Conference Web Link to participants along with the date and time of the conference call. To join your conference all your participants have to do is dial the number or use the Conference Web Link.

Join a Conference Call

Participants dial the telephone number for your conference room to join the conference call and are immediately put into the call. The telephone number is effectively the room number. No conference IDs or PINs are required, except only if a PIN has optionally been set-up. An audio indication will be heard whenever someone joins or leaves the call.

The Conference Web Link can be used to join a conference call or online meeting for free via the web from a participant's laptop or desktop. To join via the web, the participant either clicks on your Conference Web Link or enters your Conference telephone number at https://melroselabs.com/goconference/.

PIN

If you require, a PIN can be added to your conference to limit who has access to your conference. Let us know if you want a PIN added to your conference room.

Conference Rooms

You can have as many Conference rooms, each with their own telephone number, under your account as you require. Simply go to the Conference page to add a new room using the Get Conference form.

Capacity

Each conference room has an upper limit of 100 participants. If you require rooms with greater capacity, then please contact Support to discuss.

Dial-In Numbers

The Conference service comes with an 0845 non-geographic telephone number for each conference room, however alternative dial-in numbers can be used. Please note that we do not currently offer 0800 freephone dial-in numbers. Contact Support if any of the following options are of interest to you:

  • Geographic Conference Number: In the UK, we can offer geographic numbers (e.g. 0131 – Edinburgh, 0191 – Newcastle and others) and may be able to offer a local number in your own area. Geographic numbers – instead of using 0845 – are charged to the Conference account holder at £7.50 per month when charged quarterly, and £6 per month when charged annually. We offer a 7-day trial of this service.

  • BYO Numbering+Trunk: You can also bring your own (BYO) inbound SIP trunk and associated telephone numbers for use with the service.

Call Quality

Conference calls take place using wideband audio. We required, we can change audio quality to narrowband (lower quality) or ultra-wideband (higher quality).

Call Recording

Call recording is not currently available.

Calls Costs

Calls to 0845 numbers may be free from BT landlines depending on which calling plan you have and the time you make the call. More information at bt.com.

We do not charge for 0845 dial-in telephone numbers and participants may be charged by their mobile/landline provider when they call these numbers. The service charge for the 0845 dial-in telephone numbers used for participants to join conference calls is 5p/min. The participant’s landline or mobile provider (e.g. BT) may additionally charge an access charge. Some landline and mobile providers do not charge for calls to 0845 numbers. Melrose Labs does not charge participants or the Conference account holder for usage of the service. Participants should confirm actual call charges for their call plan with their own provider.

Calls to geographic dial-in numbers (e.g. 0131, 0161, 0191, etc) are charged at local/national call rates by mobile and landline providers. Participants should confirm actual call charges for their call plan with their own provider.

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

Submit conversion request and receive resulting speech

Request:

curl -X POST https://api.melroselabs.com/voice/tts/ \
    -H 'Content-Type: application/json' \ 
    -H 'x-api-key: [API_KEY]' \ 
    -d '{"voiceText": "Welcome Allan. The event for today will begin at 9.30am in room H32.", "voice": "Emma"}' \
    --output out.mp3

Response:

MP3 file

Submit conversion request

Request:

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

Response:

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

Retrieve resulting speech

Request:

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

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 of the Voice API:

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

Submit conversion request

Request:

curl -X POST "https://api.melroselabs.com/voice/speechtotext/" \
    -H 'Content-Type: audio/mp3' \
    -H 'x-api-key: [API_KEY]' \
    --data-binary @file.mp3

Response:

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

Retrieve text of speech

Request:

curl -X GET "https://api.melroselabs.com/voice/speechtotext/1ccead78-6550-4aac-a6b4-a4942b908659" \
    -H '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."}

Glossary