{"id":1251,"date":"2022-07-24T06:39:24","date_gmt":"2022-07-24T06:39:24","guid":{"rendered":"https:\/\/test.thesmsworks.co.uk\/blog\/?p=1251"},"modified":"2023-12-15T11:01:29","modified_gmt":"2023-12-15T11:01:29","slug":"sms-api-integration-checklist","status":"publish","type":"post","link":"https:\/\/thesmsworks.co.uk\/blog\/sms-api-integration-checklist\/","title":{"rendered":"19 things to check before your SMS API integration goes live"},"content":{"rendered":"\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t

<\/p>\n

19 important things to check before your SMS API integration goes live<\/strong><\/h1>\n

<\/p>\n

This list is really important. <\/strong><\/p>\n

Some of the points highlight areas where you could use more SMS credits than you intended.\u00a0<\/p>\n

<\/p>\n

Before you press \u2018go\u2019 on your SMS API integration, have a quick look at these 18, easily made mistakes.<\/p>\n

<\/p>\n

<\/p>\n

1. Check your messages are using the GSM character set<\/strong><\/h2>\n

<\/p>\n

Our SMS API platform uses the\u00a0GSM character set<\/strong>\u00a0<\/a>for transmitting SMS.<\/p>\n

<\/p>\n

\"GSM<\/figure>\n

<\/p>\n

If a message contains any character outside the GSM alphabet, UTF-16 encoding will apply, along with a\u00a070-character limit on message length<\/strong>.<\/p>\n

<\/p>\n

This allows us to support the sending of emoticons, which many customers need.<\/p>\n

<\/p>\n

UTF-16 encoding a message dramatically reduces the numbers of characters available per text credit. Instead of the usual 160 characters, a UTF-16 encoded message allows just 70.<\/p>\n

<\/p>\n

This is reflected in the number of credits used to send the message (i.e.\u00a0we will charge you 1 credit per 70 characters<\/strong>.)<\/p>\n

<\/p>\n

\n

Don\u2019t be tempted to copy and paste content from Microsoft Word or other word processing applications. This would probably result in non-GSM characters being used and the message sent as UTF-16.\u00a0<\/strong><\/p>\n<\/blockquote>\n

<\/p>\n

Some characters, such as certain apostrophes and hyphens may appear to be in the GSM character set but actually contain subtle differences.<\/p>\n

<\/p>\n

The apostrophe and hyphen are probably the most commonly mis-used characters.<\/p>\n

<\/p>\n

Also be careful when using the pound sign and check that you’ve tested this before your integration goes into production.<\/p>\n

<\/p>\n

Use our free\u00a0unicode detector<\/a><\/strong>\u00a0to identify and remove any non-gsm characters in your text messages<\/p>\n

<\/p>\n

2. Triple-check your code in all possible scenarios<\/strong><\/h2>\n

<\/p>\n

Please make sure that you\u2019ve thoroughly checked your code so that it functions as expected in all different scenarios.<\/p>\n

<\/p>\n

Make sure that you\u2019ve understood the\u00a0error codes<\/a><\/strong>\u00a0that we respond with and that your system responds appropriately.<\/p>\n

<\/p>\n

Check that your code can\u2019t run wild and send out messages in an uncontrolled way.
You don\u2019t want to find that your SMS credits have all been consumed very quickly because of an obvious error.<\/p>\n

<\/p>\n

I\u2019m afraid\u00a0we can\u2019t refund credits that have been lost in this way<\/strong>. Our code samples have been thoroughly tested but it\u2019s important that you ensure they work in your unique set-up.<\/p>\n

<\/p>\n

(Again, we can\u2019t be held responsible for problems that arise because of use of our code snippets in your environment.)<\/p>\n

<\/p>\n

We have a\u00a0flooding filter<\/strong><\/a>\u00a0which is there to help prevent a single person receiving multiple messages in a short space of time.
A single number can only receive 20 varied messages and 3 identical messages per hour.<\/p>\n

<\/p>\n

In some situations though, the flooding filter may not prevent multiple message being sent, so please don\u2019t rely on it to prevent multiple messages being attempted. (We can\u2019t refund credits that have been lost because the flooding filter didn\u2019t stop messages being delivered.)<\/p>\n

<\/p>\n

Please also check that the flooding filter won’t prevent intended messages from being delivered.
If you’re using our service for server alerts for example, it’s conceivable that you may want to send more than 6 identical messages in a 1 hour period.<\/p>\n

<\/p>\n

3. Set up low credits warning email alerts<\/strong><\/h2>\n

<\/p>\n

Running out of SMS credits<\/a><\/strong>\u00a0is a worry for most customers. To prevent this happening, you can set up\u00a0low credits warning emails<\/strong>.<\/p>\n

<\/p>\n

You\u2019ll be sent daily emails when your account falls below a set number of credits remaining.<\/p>\n

<\/p>\n

To set up your low credits warning alerts, simply log into your account and scroll to Low Credit Warning. Here you can set the number of credits below which the alerts will be triggered.<\/p>\n

<\/p>\n

We suggest that you trigger the alerts when you have about 3 weeks of credit remaining. That way you\u2019ll have plenty of time before the account runs out.<\/p>\n

<\/p>\n

Don\u2019t forget to add all the contacts that need to receive the alerts and make sure that you’ve whitelisted our domains so that you can receive the emails, see below – point 8.<\/p>\n

You can also set up SMS auto top up<\/a><\/strong>. This will automatically make a purchase of a certain number of SMS credits if the credits level drops below a set level.<\/p>\n

<\/p>\n

You can also apply for an\u00a0SMS overdraft.<\/a><\/strong>\u00a0This allows your account to continue sending even if the credit level falls below zero.
This overdraft is agreed with us in advance and we usually set the overdraft to around 2 weeks of SMS usage.<\/p>\n

<\/p>\n

4. Check you have the relevant permissions to send SMS<\/strong><\/h2>\n

<\/p>\n

Since GDPR came into force in May 2018, the rules surrounding the sending of marketing texts have become stricter.<\/p>\n

<\/p>\n

If you\u2019re planning to send marketing texts to your customers, \u00a0you\u2019ll need to make sure you have their permission.<\/p>\n

<\/p>\n

Failure to do so could result in some\u00a0rather alarming fines<\/a>\u00a0if people complain.<\/p>\n

<\/p>\n

The rules are designed to protect consumers but there\u2019s nothing too much to worry about. There are a number of \u2018legitimate interests<\/a>\u2019 that allow you to send marketing texts.<\/p>\n

<\/p>\n

This guide on\u00a0SMS opt out\u00a0rules<\/a><\/strong>\u00a0might be useful<\/p>\n

<\/p>\n

5. Make sure that replies are being handled correctly<\/strong><\/h2>\n

<\/p>\n

If your SMS service has a reply option, ensure that your have configured the URL to which you want incoming texts to be sent and that it\u2019s been tested from end to end.<\/p>\n

<\/p>\n

Incoming texts can also be sent to you by email. This can be\u00a0easily configured in your account<\/strong>.<\/p>\n

<\/p>\n

6. Check the message length is as intended<\/strong><\/h2>\n

<\/p>\n

A standard text message using the GSM character set is 160 characters including spaces. Messages that are longer than 160 characters will use more than one text credit. Messages can be up to a maximum of 1280 characters in length.<\/p>\n

<\/p>\n

Messages longer than 160 characters get segmented into chunks of 153 characters to send to the recipient’s handset, so you’ll be charged 1 credit per 153 characters.<\/p>\n

<\/p>\n

(The missing 7 characters are used to insert instructions to stitch longer messages together, so that they arrive as one long text rather than a series of texts.)<\/p>\n

<\/p>\n

For more information on the credit usage, please visit our\u00a0developers’ page<\/a><\/strong>.
Also see our in depth article about\u00a0SMS message length<\/a><\/strong>.<\/p>\n

<\/p>\n

Before your SMS integration goes into production, please make sure that you’ve checked that message length is correct. Unfortunately, we can’t refund credits that have been consumed because of a miscalculation.<\/p>\n

<\/p>\n

Our free\u00a0SMS message length calculator<\/a><\/strong>\u00a0shows the number of characters\u00a0in a text and how many SMS credits will be needed to send it.<\/p>\n

<\/p>\n

7. Failed international texts are not refunded<\/strong><\/h2>\n

<\/p>\n

This is more of a reminder than something to check. Non-delivered international texts are not refunded back to customers\u2019 accounts.<\/p>\n

<\/p>\n

The reason for this simple. We are charged for all non-UK SMS traffic that we submit, so we have to charge for international texts, regardless of delivery outcome.<\/p>\n

<\/p>\n

Also, please note that if you’re intending to send messages outside the UK, then you will need to contact us so that we can enable your account for international sending. Don’t worry though, it only takes a minute.<\/p>\n

<\/p>\n

International delivery reports are also far less detailed than those for the UK. In many cases we are unable to determine why a particular message has failed as the relevant network do not always provide us with the relevant information.<\/p>\n

<\/p>\n

Unfortunately when this is the case we won’t be able to obtain further information.<\/p>\n

<\/p>\n

If you’re planning to send messages outside the UK, please\u00a0 also read this\u00a0important article about international SMS<\/a>.<\/strong> It highlights a few things you need to be aware of.<\/p>\n

<\/p>\n

One final note. It costs more to send to international mobile numbers. Here’s our\u00a0international pricing table<\/a>.<\/p>\n

<\/p>\n

8. White list our domains<\/strong><\/h2>\n

<\/p>\n

If you\u2019re using our SMS to email reply function, make sure that our emails aren\u2019t going to get stuck in your spam filters.<\/p>\n

<\/p>\n

If you ever change your login credentials, you\u2019ll also need to be able to receive emails from us.<\/p>\n

<\/p>\n

The 2 domains from which email are sent are as follows.<\/p>\n

<\/p>\n

@thesmsworks.co.uk
@thesmsworks.net<\/strong><\/p>\n

<\/p>\n

Please contact us if you need to white list our IP addresses, so that you can receive data sent to a URL endpoint. (support@thesmsworks.co.uk)<\/p>\n

<\/p>\n

9. Generating a new key and secret from your account will invalidate the existing token<\/strong><\/h2>\n

<\/p>\n

Please be aware that if you generate a new key and secret from your account page, then your existing token will be invalidated and your texts will stop sending.<\/p>\n

<\/p>\n

Make sure that all the relevant staff are aware of this, so that no mishaps occur.<\/p>\n

<\/p>\n

Your account will ask you to confirm that you want to generate a new secret and key along with a warning of the consequences!<\/p>\n

<\/p>\n

If you need further clarification or need an extra account for testing, just ask us. We\u2019re here to help.<\/p>\n

<\/p>\n

10. Delivery reports will expire after 3 months<\/strong><\/h2>\n

<\/p>\n

Please not that due to very large files sizes,\u00a0SMS delivery reports<\/a><\/strong>\u00a0will expire after 3 months and will no longer be accessible. If you need access to your delivery data, please make sure you download reports before they are permanently deleted.<\/p>\n

<\/p>\n

11.\u00a0If you use the \u2018ttl\u2019 parameter you will not be able to view delivery reports<\/strong><\/h2>\n

<\/p>\n

The ttl\u00a0(time to live) parameter allows you to remove all message data from our systems after a set number of minutes. For data protection, some customers are required to remove all data from third parties.<\/p>\n

<\/p>\n

If you\u2019ve used this tool, then you won\u2019t be able to access delivery reports because we will have deleted all data.<\/p>\n

<\/p>\n

12. Server locations<\/strong><\/h2>\n

<\/p>\n

All servers and data centres used to handle data and send SMS messages are\u00a0based in the UK<\/a><\/strong>.<\/p>\n

<\/p>\n

13. Is your testing to one number triggering our flooding filters?<\/strong><\/h2>\n

<\/p>\n

An ‘SMS flooding filter<\/strong><\/a>‘ is in place to prevent individuals being sent the same message repeatedly in a short space of time. A single number can only receive 20 varied messages and 6 identical messages per hour.<\/p>\n

<\/p>\n

When conducting testing, please use a selection of mobile numbers to prevent messages being rejected.<\/p>\n

<\/p>\n

14.\u00a0Conduct your testing using UK phone numbers<\/strong><\/h2>\n

<\/p>\n

Do you use developers based overseas?<\/p>\n

<\/p>\n

This can cause problems when trying to test a service which will mainly be used in the UK.<\/p>\n

<\/p>\n

Problems often occur when using non-UK\u00a0mobile numbers for testing. For example some overseas networks do not permit alphanumeric sender IDs, so this can’t be tested accurately. Delivery reporting can also be slower and reporting not as consistent as the UK networks.<\/p>\n

<\/p>\n

If your service is mainly going to be based in the UK, then please use UK numbers for testing.<\/p>\n

15. Set webhook alarm triggers<\/strong><\/h2>\n

This is a safeguarding tool that alerts you by email if the webhooks that you have configured stop working or become unresponsive.<\/p>\n

This webhook monitor gives you piece of mind that your webhooks are functioning as intended.<\/p>\n

You’ll find more detail on this on the Incoming SMS monitor<\/a><\/strong> page.<\/p>\n

16. Do you have a web form that generates an SMS? Make sure it\u2019s not a victim of SMS pumping<\/strong><\/h2>\n

SMS traffic pumping fraud<\/a> <\/strong>happens when fraudsters take advantage of a mobile phone number input field on a web form. <\/span><\/p>\n

They ambush it by triggering large volumes of outbound texts to automatically generated mobile numbers. The criminals benefit from a revenue share with a mobile network.<\/span><\/p>\n

17. Enable our costing saving tools<\/strong><\/h2>\n

Consider enabling our AI SMS optimiser<\/a><\/strong>, unicode replacement<\/strong><\/a> and emoji removal<\/a><\/strong> tools. They could save you a considerable unintended overspend.<\/p>\n

18. Check that the sender IDs you intend to use are permitted<\/strong><\/h2>\n

BT\/EE have brought in a new code of conduct to help reduce fraudulent SMS on their network.
Generic sender IDs like ‘Info’ or ‘appointment’ will be blocked.
Foreign virtual reply are numbers are not permitted.
UK reply numbers and short code are allowed.
BT\/EE will block suspected spam or fraudulent URLs<\/p>\n

We suggest that you test all the messages and sender IDs before going live.
The following article details the new code of conduct for sending business SMS.<\/a><\/strong><\/p>\n

19. Don\u2019t generate a new JSON Web Token for every text that you send<\/strong><\/h2>\n

There\u2019s no need to renew your JSON Web Token for every text that you send and doing this could cause issues.<\/p>\n

you should treat your JSON Web Token like a password, and renew it periodically, inline with your organisation’s password policy.<\/p>\n

<\/p>\n

Can we help at all?<\/strong><\/h2>\n

<\/p>\n

If you run into any bumps in the road while getting your SMS integration ready for action, then please don\u2019t hesitate to be in touch. We may be able to help.<\/p>\n

<\/p>\n

Sometimes, just having a different set of eyes on a problem can help a solution emerge.<\/p>\n

<\/p>\n

Customers have said\u00a0some very kind things<\/a><\/strong>\u00a0about our service, reliability and support, so I hope we\u2019ll be able to provide you with a top notch service.<\/p>\n

<\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t<\/div>\n\t\t","protected":false},"excerpt":{"rendered":"

19 important things to check before your SMS API integration goes live This list is really important. Some of the […]<\/p>\n","protected":false},"author":3,"featured_media":1614,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"default","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","ast-disable-related-posts":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"set","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"footnotes":""},"categories":[1],"tags":[],"class_list":["post-1251","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-uncategorized"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/thesmsworks.co.uk\/blog\/wp-json\/wp\/v2\/posts\/1251","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/thesmsworks.co.uk\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/thesmsworks.co.uk\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/thesmsworks.co.uk\/blog\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/thesmsworks.co.uk\/blog\/wp-json\/wp\/v2\/comments?post=1251"}],"version-history":[{"count":0,"href":"https:\/\/thesmsworks.co.uk\/blog\/wp-json\/wp\/v2\/posts\/1251\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/thesmsworks.co.uk\/blog\/wp-json\/wp\/v2\/media\/1614"}],"wp:attachment":[{"href":"https:\/\/thesmsworks.co.uk\/blog\/wp-json\/wp\/v2\/media?parent=1251"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/thesmsworks.co.uk\/blog\/wp-json\/wp\/v2\/categories?post=1251"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/thesmsworks.co.uk\/blog\/wp-json\/wp\/v2\/tags?post=1251"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}