Author: Steve Purvey

How the integration works

When an agent sends a text, Yeastar posts it to everymessage with your API key, and we send it to the mobile networks. When a customer replies to your number, we sign the reply with your Secret and post it to your Yeastar PBX, which routes it to the extension, message queue or message flow you choose. Yeastar can also check the connection from time to time with a quick verification request.

What you need

• Yeastar P-Series Software Edition, firmware 83.23.0.24 or later
• A domain name for your PBX with a valid certificate. Yeastar notes the domain must not contain an underscore
• An everymessage account with an API key, and a Secret for signing webhooks
• An SMS-enabled number from everymessage for customers to text and reply to

Setting it up in Yeastar

1. Get your details from us. We provide your API key (your API username:password, Base64-encoded), a Secret, and your SMS number.
2. Add the channel. In the Yeastar web portal go to Messaging > Message Channel, click Add and choose SMS.
3. Fill in the Authentication tab. Enter a name, set ITSP to General, and enter the values in the table below.
4. Send us the webhook URL. Choose a Webhook URL from the drop-down, copy it and send it to us. We set it against your number with your Secret, so replies are signed.
5. Set the sending rate. On the Messaging Settings tab, set the message sending rate. Ask us if you need to send faster than your account allows.
6. Add your number. In the Number section, add your everymessage number in E.164 format, for example +447700900456, and choose where inbound messages go: an extension, a message queue or a message flow. Then choose which extensions can start conversations, and save.
7. Test. Check the channel shows as connected, send a text from Linkus, then reply from the mobile and check the reply reaches the right agent.

Picture messages (MMS)

When someone sends a picture, video or document from Yeastar, everymessage delivers it as an ordinary SMS with a personal, secure link. The link opens a page showing the message and the media, so it works on every phone and network. MMS itself is still patchy on many UK phones and networks.

• Up to 10 files per message, each up to 5 MB: images (JPEG, PNG, GIF, WebP, HEIC), video (MP4, MOV, 3GP, WebM), audio (MP3, M4A, AAC, AMR, OGG, WAV), PDF and contact cards (vCard).
• Private by default. Files are copied to UK storage and only shown through the recipient’s own link, which can’t be guessed. Links stay live for 30 days.
• Text is optional. If a message has no text, we add a short line such as “You’ve been sent a picture. View it here:”.
• Delivery reports work as normal, because the message itself is an SMS.
• Simple pricing. A picture message is charged as an SMS plus a media hosting fee.

If any file can’t be fetched or isn’t a supported type, nothing is sent and Yeastar gets error 10003 with the reason.

Sending from your company name

Yeastar sends each text from the number on the SMS channel. If you’d rather customers see your company name, you can set a sender name of up to 11 characters on that number, for example BrightDent, in the everymessage portal (Numbers → edit the number → PBX sender name), or ask us and we’ll set it for you. Texts sent from that number then go out from the name instead, and Yeastar keeps the conversation under your number.

• One-way only. Customers can’t reply to a name, so use it for numbers that send notifications, not conversations.
• UK sender ID rules apply. Letters, numbers and spaces, at least one letter, and no restricted generic names such as Verify or OTP. See UK SMS sender ID rules.
• Per number. Your other numbers keep sending from the number, so two-way conversations carry on as normal.

API reference

You don’t need this to use Yeastar, but it shows exactly what Yeastar and everymessage exchange, which helps when testing or troubleshooting. The full reference, with code examples, is in our developer docs: Phone systems (PBX) API.

Verify the connection

Yeastar sends a random challenge with your API key. A valid key returns HTTP 200 with the same challenge in the body.

curl "https://api.everymessage.com/v1/pbx/verify?challenge=mAWpGnyeTZgguOPY" \
  -H "Authorization: Bearer YOUR_API_KEY"

Send a message

Yeastar posts each text as JSON. from, to and text are all required, and numbers are in E.164 format.

curl -X POST "https://api.everymessage.com/v1/pbx/messages" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{"from": "+447700900456", "to": "+447700900123", "text": "Your order is ready to collect."}'

A successful request returns HTTP 200 with the message details, including the everymessage message id. Errors return a JSON errors list using Yeastar’s error codes, listed under common problems below.

Send a picture message

Add media_urls with up to 10 public file URLs. text is optional when media is included. The response is the same as for a text message.

{"from": "+447700900456", "to": "+447700900123", "text": "Here's the quote you asked for.",
 "media_urls": ["https://files.example.com/quote-1042.pdf"]}

Replies

Customer replies are posted to your Yeastar webhook as a message.received event. When a Secret is set, the request carries an X-Signature-256 header: sha256= followed by the lowercase hex signature of the request body made with your Secret.

{
  "data": {
    "event_type": "message.received",
    "record_type": "event",
    "payload": {
      "id": "123789",
      "direction": "inbound",
      "type": "SMS",
      "from": { "phone_number": "+447700900123" },
      "to": [ { "phone_number": "+447700900456" } ],
      "text": "Can I collect it tomorrow?",
      "received_at": "2026-10-13T09:15:04.511Z"
    }
  }
}

Common problems and fixes

Why use everymessage for Yeastar SMS

Using 3CX? The same everymessage PBX API works with it too: see 3CX SMS. For other platforms, see NetSapiens SMS, Amazon Connect and every way to connect on our Business SMS page.

Frequently asked questions

How the integration works

3CX sends each outgoing text to everymessage as a simple request with your API key. We send it to the mobile networks and track delivery. When the message is delivered, or a customer replies to your number, we post it straight back to your 3CX system, which shows it in the right conversation.

What you need

• A 3CX system that supports SMS through a generic provider
• An everymessage account with an API key
• An SMS-enabled number from everymessage for customers to text and reply to, set up in 3CX
• Your 3CX webhook URL, which 3CX shows when you add the SMS provider

Setting it up

1. Get your API key. We provide your everymessage API username and password. Your API key is username:password, Base64-encoded.
2. Add the SMS provider in 3CX. In your 3CX SMS settings, choose the generic provider, enter the everymessage messages URL below, and paste in your API key.
3. Add your number. Set up your everymessage SMS number in 3CX and choose which users or queues handle its texts.
4. Send us your webhook URL. Copy the webhook URL 3CX shows for the provider and send it to us. We set it against your number in the 3CX / Yeastar (PBX) format, for both replies and delivery reports.
5. Test. Send a text from 3CX, check it arrives and shows as delivered, then reply from the mobile and check the reply appears in 3CX.

Picture messages (MMS)

When someone sends a picture, video or document from 3CX, everymessage delivers it as an ordinary SMS with a personal, secure link. The link opens a page showing the message and the media, so it works on every phone and network. MMS itself is still patchy on many UK phones and networks.

• Up to 10 files per message, each up to 5 MB: images (JPEG, PNG, GIF, WebP, HEIC), video (MP4, MOV, 3GP, WebM), audio (MP3, M4A, AAC, AMR, OGG, WAV), PDF and contact cards (vCard).
• Private by default. Files are copied to UK storage and only shown through the recipient’s own link, which can’t be guessed. Links stay live for 30 days.
• Text is optional. If a message has no text, we add a short line such as “You’ve been sent a picture. View it here:”.
• Delivery reports work as normal, because the message itself is an SMS.
• Simple pricing. A picture message is charged as an SMS plus a media hosting fee.

If any file can’t be fetched or isn’t a supported type, nothing is sent and 3CX gets error 10003 with the reason.

Sending from your company name

3CX always sends from the number set on the extension. If you’d rather customers see your company name, you can set a sender name of up to 11 characters on that number, for example BrightDent, in the everymessage portal (Numbers → edit the number → PBX sender name), or ask us and we’ll set it for you. Texts sent from that number then go out from the name instead, and 3CX keeps the conversation under your number.

• One-way only. Customers can’t reply to a name, so use it for numbers that send notifications, not conversations.
• UK sender ID rules apply. Letters, numbers and spaces, at least one letter, and no restricted generic names such as Verify or OTP. See UK SMS sender ID rules.
• Per number. Your other numbers keep sending from the number, so two-way conversations carry on as normal.

API reference

You don’t need this to use 3CX, but it shows exactly what 3CX and everymessage exchange, which helps if you’re testing or troubleshooting. The full reference, with code examples, is in our developer docs: Phone systems (PBX) API.

Send a message

3CX posts each text as JSON, with your API key as a Bearer token. from, to and text are all required, and numbers are in E.164 format.

curl -X POST "https://api.everymessage.com/v1/pbx/messages" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{"from": "+447700900456", "to": "+447700900123", "text": "Your engineer is on the way."}'

Errors return a JSON errors list with a code, title and detail; the codes are listed under common problems below. A successful request returns HTTP 200 with the message details. The id is the everymessage message id, which 3CX uses to match the delivery report:

{
  "data": {
    "record_type": "message",
    "direction": "outbound",
    "id": "123456",
    "type": "SMS",
    "from": { "phone_number": "+447700900456" },
    "to": [ { "phone_number": "+447700900123", "status": "queued" } ],
    "text": "Your engineer is on the way.",
    "encoding": "GSM-7",
    "parts": 1
  }
}

Send a picture message

Add media_urls with up to 10 public file URLs. text is optional when media is included. The response is the same as for a text message.

{"from": "+447700900456", "to": "+447700900123", "text": "Here's the quote you asked for.",
 "media_urls": ["https://files.example.com/quote-1042.pdf"]}

Replies

Customer replies are posted to your 3CX webhook as a message.received event:

{
  "data": {
    "event_type": "message.received",
    "record_type": "event",
    "payload": {
      "id": "123789",
      "direction": "inbound",
      "type": "SMS",
      "from": { "phone_number": "+447700900123" },
      "to": [ { "phone_number": "+447700900456" } ],
      "text": "Thanks, see you soon",
      "received_at": "2026-10-13T09:15:04.511Z"
    }
  }
}

Delivery reports

When a message is delivered or fails, a message.finalized event is posted to the same webhook. payload.id is the id returned when the message was sent, and to[].status is delivered or delivery_failed.

Common problems and fixes

Why use everymessage for 3CX SMS

Using Yeastar? The same everymessage PBX API works with it too: see Yeastar SMS. Using a different phone or contact centre platform? See NetSapiens SMS, Amazon Connect and every other way to connect on our Business SMS page.

Frequently asked questions

How the integration works

NetSapiens treats everymessage like any other SMS carrier. When a user sends a text, NetSapiens posts it to the everymessage gateway, which sends it to the mobile networks and records delivery. When a customer replies to one of your everymessage numbers, we forward the message to your NetSapiens server, which routes it to the right user.

What you need

• NetSapiens v43 or later with the SMS Advanced API enabled (v44 or later if you want to keep the + on inbound numbers)
• An everymessage account with API credentials
• CLI or SSH access to your NetSapiens core server, where the carrier settings live
• SMS-enabled numbers provisioned on everymessage, for customers to text and reply to

Setting it up

The integration is a short block of carrier settings on the NetSapiens core server, plus a webhook we set against your numbers. These are the steps; the complete configuration follows.

1. Choose a carrier name. NetSapiens carrier names must be lowercase and 16 characters or fewer, for example everymessage. A name with capital letters makes outbound messages fail silently.
2. Point the carrier at everymessage. Set the carrier URL to the everymessage send endpoint we give you, with form-encoded requests.
3. Map the outbound fields. NetSapiens’ from, to and text values map to the everymessage sender, numbers and message fields.
4. Add your API key. Your everymessage API key is added as a custom outbound field, so it’s included in every request.
5. Set the number format. everymessage expects international numbers without a leading +, for example 447700900123, so the outbound plus options are turned off.
6. Set up inbound. Send us your NetSapiens inbound webhook URL, including your carrier name, and we’ll set it against your numbers. On the NetSapiens side, map the inbound number, sender and message fields, and tell NetSapiens where to find them in our payload.

Carrier API configuration

This is the complete carrier configuration. Add it to /etc/netsapiens/api_config.php on your NetSapiens core server (or nsconfig_include.php, depending on your deployment), and replace the values in capitals:

• FQDN in the URL: the everymessage API address we give you.
• BASE64_ENCODED_USERNAME_PASSWORD: your everymessage API key, which is your API username and password in the form username:password, Base64-encoded.

// everymessage SMS carrier configuration

// API endpoint
Configure::write('NSCarrier.everymessage.url',
  "https://FQDN/send");

// Content type
Configure::write('NSCarrier.everymessage.content_type',
  'application/x-www-form-urlencoded');

// Outbound parameter mapping
Configure::write('NSCarrier.everymessage.outboundFrom', "sender");
Configure::write('NSCarrier.everymessage.outboundTo', "numbers");
Configure::write('NSCarrier.everymessage.outboundText', "message");

// Number formatting (no plus prefix)
Configure::write('NSCarrier.everymessage.outboundToPlus', false);
Configure::write('NSCarrier.everymessage.outboundFromPlus', false);

// Authentication via apiKey form field
Configure::write('NSCarrier.everymessage.customOutboundJsonFields',
  "apiKey");
Configure::write('NSCarrier.everymessage.customOutboundJsonFields.apiKey',
  "BASE64_ENCODED_USERNAME_PASSWORD");

// Inbound: messages arrive inside a "list" array
Configure::write('NSCarrier.everymessage.customNestedInboundFields',
  ["list", 0]);

// Inbound parameter mapping
Configure::write('NSCarrier.everymessage.inboundTo', "inboxNumber");
Configure::write('NSCarrier.everymessage.inboundFrom', "sender");
Configure::write('NSCarrier.everymessage.inboundText', "content");

Inbound sender numbers arrive in international format with a +, for example +447700900123. If your deployment expects the +, NetSapiens v44 and later can keep it:

// Keep the + on inbound numbers (v44 and later)
Configure::write('NSCarrier.everymessage.inboundToPlus', true);
Configure::write('NSCarrier.everymessage.inboundFromPlus', true);

Inbound webhook URL

Send us your NetSapiens inbound webhook URL and we’ll set it against your everymessage numbers. Replace FQDN with your NetSapiens server’s address, and use the same carrier name as in your configuration:

https://FQDN/ns-api/?object=sms&action=create&inboundSMS=true&nsCarrier=everymessage

Replies are delivered inside a list array, which is why the configuration tells NetSapiens to read the first item with ["list", 0]:

{
  "list": [
    {
      "type": "INBOUND_MESSAGE",
      "messageId": 987,
      "sender": "+447700900123",
      "inboxName": "support",
      "inboxNumber": "447700900456",
      "content": "Yes, please book me in",
      "dateTime": "2026-10-13T09:15:04.511Z"
    }
  ]
}

Test your credentials

Before testing through NetSapiens, check your API key with a direct request in test mode. test=true validates the request without sending the message or using credit, and a successful response includes "status": "success".

curl -X POST "https://FQDN/send" \
  -d "apiKey=BASE64_ENCODED_USERNAME_PASSWORD" \
  -d "sender=YourCompany" \
  -d "message=Test from NetSapiens" \
  -d "numbers=447700900123" \
  -d "test=true"

Then send a text from NetSapiens and check the messaging log (tail -f path-to-api/tmp/logs/messaging.log) for NS_SMS200. For replies, look for (Messages.dispatch) create1, which shows the webhook arrived.

Common problems and fixes

Why use everymessage as your NetSapiens SMS carrier

Using a different platform? See our Business SMS page for every way to connect, including the SMS API, SMPP, email-to-SMS and Amazon Connect.

Frequently asked questions

Why add SMS to your contact centre?

• Customers already text. Every mobile phone can send an SMS, with no app, login or data connection needed.
• Fewer calls, shorter queues. Offering “text us instead” in your phone menu or on your website moves simple queries to messaging, where an agent can handle several conversations at once.
• Replies to your own messages. Customers can reply to an appointment reminder, delivery update or bill, and the reply reaches someone who can help.
• Asynchronous by nature. Customers reply when it suits them, without staying on a call.

Two ways to do it

Both approaches let agents answer texts in Amazon Connect, and both let your contact flows route them. The difference is where your numbers, registrations and messaging live.

Option 1: native SMS through AWS

AWS End User Messaging SMS provides SMS numbers that you import into Amazon Connect. In outline:

1. Request a number in the AWS End User Messaging SMS console for the country you’ll message, with two-way messaging switched on. Some countries need the number or sender ID registered first, which AWS says can take up to 15 business days.
2. Enable two-way SMS on the number, with Amazon Connect as the destination, and import it into your instance.
3. Update your flows to recognise SMS contacts and route them to the right queue.
4. Go to production: move your account out of the SMS sandbox and check your spending limit.

Points to know: a number can’t be shared between voice and SMS, and opt-out keywords such as STOP are handled by AWS unless you set up your own opt-out handling. In the UK, AWS supports two-way SMS on long codes and short codes, and alphanumeric sender IDs must be registered.

Option 2: connect your SMS provider

If you already send texts through a messaging provider, you can connect it to Amazon Connect instead. With everymessage it works like this:

1. A customer texts one of your numbers. The number is set to send its replies to Amazon Connect.
2. A chat contact starts in Amazon Connect, using the contact flow you choose, so your routing, opening hours and bots apply. Further texts from the same customer join the same conversation while it’s open.
3. The agent replies in their usual workspace. Amazon Connect streams the reply to a notification topic in your AWS account, which is shared with everymessage.
4. The reply goes out as an SMS from the same number, so the customer just carries on texting.

Access is through a role in your AWS account, protected by an external ID, with only the Amazon Connect permissions the integration needs. No AWS keys are shared, and you can withdraw access at any time. See SMS for Amazon Connect (currently in Beta).

Sending texts from your contact flows

Whichever option handles inbound texts, your flows can also send SMS. Add an “Invoke AWS Lambda function” block, and have the function call an SMS API. Common uses:

• After a call: a confirmation, reference number or summary of what was agreed.
• Instead of waiting: a callback link or a link to self-service while the customer is in the queue.
• Payments: a secure payment link, so card details are never read out over the phone.
• Feedback: a short satisfaction survey when the contact ends.

The everymessage SMS API takes a single HTTPS request and returns a message ID you can store against the contact. Delivery receipts can be sent to your systems by webhook.

Good practice for SMS in a contact centre

• Use a number customers can reply to. Messages from a sender name such as your company name can’t be replied to.
• Set expectations. Tell customers your messaging hours and how quickly you reply, and use an automatic reply outside hours.
• Keep sensitive details out of texts. Send a secure link instead of account numbers or personal data. See digital letters.
• Honour opt-outs. Make sure STOP requests are recorded and respected across every system that sends texts.
• Keep messages short. Long replies are split into several parts and cost more. See SMS character limits explained.
• Think beyond SMS. For customers who prefer them, RCS and WhatsApp offer richer conversations. Compare them in RCS vs SMS vs WhatsApp.

Which should you choose?

Frequently asked questions

How it works

1. Register your email address. Your email address is your everymessage login. We only accept email to SMS from registered addresses, so your credit can’t be used by anyone else.
2. Address the email to a mobile number. Put the number in front of @emsg.me.uk. Add as many numbers as you need in To, Cc or Bcc.
3. Write your message. We take the email body (or the subject, if your account is set up that way), remove signatures and quoted replies, and send it as an SMS.
4. Get receipts and replies by email. Delivery receipts and replies from the mobile come back to your inbox, if your account is set up for them.

Addressing your email

The part of the address before the @ is the mobile number. Use digits only. We convert UK numbers to international format for you.

• Several recipients: add each number as a separate address. To, Cc and Bcc all work, so you can Bcc mobiles without the others seeing them.
• Other email addresses: you can copy in colleagues on ordinary email addresses. They get the email as normal; only the @emsg.me.uk addresses are sent as texts.
• Avoid the + sign and spaces in the address. Some email programs change or reject them.

Body or subject: what gets sent

By default, the email body becomes the SMS and the subject is ignored. If you’d rather type short messages in the subject line, turn on Use subject as SMS for your account. The subject is then sent, and the body is ignored.

When we read the body, we:

• use the plain-text version of the email, or convert HTML email to plain text;
• stop at the first quoted reply or signature break: a line starting --, -----Original Message-----, On ... wrote:, From:, a line of underscores, or a line starting >;
• tidy up extra spaces and blank lines.

Attachments are not sent. For the best results, send plain-text email and keep to standard characters: see SMS character limits for why that matters.

Choosing the sender

Your texts come from your account’s default sender, which is a sender name (up to 11 letters and numbers) or one of your mobile numbers. To use a different sender for one message, add sender= at the end of the subject line:

Put the sender= token last, because everything after it is read as the sender. The sender must be a name you’re allowed to use, or a number on your account.

Keeping disclaimers and signatures out of your texts

Most business email adds a signature or legal disclaimer. Signatures that start with a standard -- line are removed automatically. For anything else, there are two ways to stop it reaching the text.

The text above sends only Your engineer will arrive between 10:00 and 12:00 today. Don’t use ## inside the message itself, because the first ## ends it.

A third option is Use subject as SMS: the body, and any disclaimer in it, isn’t sent at all.

Account settings for email to SMS

An administrator sets these for each user in the portal (Users, then Edit).

Delivery receipt emails

With the delivery rule set to email, you get an email when the network confirms the outcome. The subject says whether the message was delivered, expired or rejected, and the original message is quoted underneath.

Each receipt comes from the mobile number itself, for example 447700900123@emsg.me.uk. Reply to the receipt and your reply is sent to that mobile as a new text.

Replies: SMS back to your email

People can’t reply to a sender name such as BRIGHTCARE. To have a conversation, send from a two-way mobile number on your account:

1. Set the user’s Originator to your two-way number, or add sender= with the number to the subject.
2. Set the number’s Reply handling to Email (or Email & URL, to also send replies to your system).
3. Replies arrive in your inbox, sent to the email address of the user who sent the original message. Each one comes from the mobile, for example 447700900123@emsg.me.uk, with your original message quoted below.
4. Reply to the email to answer. Your reply goes back to the mobile as a text. The quoted history in your reply is removed automatically, so only your new words are sent.

A text that isn’t a reply to a recent message, such as a customer texting your number first, is emailed to the number’s owner with the subject Incoming SMS. You can reply to it in the same way.

Security

• Registered senders only. Email from addresses that aren’t registered users is rejected.
• Checked at the door. Incoming email must pass SPF, and can also be required to pass DKIM, so messages pretending to come from your domain are refused.
• Spam and viruses are filtered before anything is read. Automatic replies, out-of-office messages and bounces are ignored, so they never become texts.
• Whole-domain sign-up (optional). Your administrator can let anyone at your company’s email domain send without being added one by one. New senders get your company’s default settings.

If a message isn’t sent

We email the sender with the reason. The common ones:

Frequently asked questions