Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.




Html
 <div class="lang-box-pdf">
	<div>
		<div class="google-lang">
			<div id="google_translate_element">
			</div>
			<script type="text/javascript">
					function googleTranslateElementInit() {
						new google.translate.TranslateElement({pageLanguage: 'en', includedLanguages: 'de,es,fr,it,nl', autoDisplay: false}, 'google_translate_element');
						}
			</script>
			<script type="text/javascript" src="//translate.google.com/translate_a/element.js?cb=googleTranslateElementInit"></script>
		</div>
		
		<div class="pdf-button">
			<a href="https://confluence.wildix.com/spaces/flyingpdf/pdfpageexport.action?pageId=75793464" alt="Convert to .pdf" title="Convert to .pdf"><img src="https://confluence.wildix.com/download/attachments/14549012/pdf-button-download-wildix-documentation.png"></a>
		</div>
	</div>
</div>

...

Info

This document describes how to configure and exchange SMS messages using CLASSOUND service.

For US/ Canadian Fully Ported Numbers support starts from WMS v. 5.02.20201015.2.

For non-US/ Canadian numbers, support starts from WMS Beta v. 5.04.2021121420220309.3.1

Created: August 2020

Updated: June 2022

Permalink: https://confluence.wildix.com/x/OISEB

...

Note

Note: By default, Wildix provides a package of 200 SMS per each user per month. Once the package is used, a fee will be charged for each sent SMS. The same fee as for calls is applied (CallTerminationArea_1). You can check the fee on WMP -> Price list -> CLASSOUND.

Prerequisites

...

Two-way SMS 

Prerequisites

  • Activated CLASSOUND 

  • Min. license type: UC-Business (only users with UC-Business and UC-Premium licenses can send and receive SMS)
  • CLASSOUND DID configured as Office number for those users who need to exchange SMS messages via CLASSOUND
Warning

Important: SMS can be sent only to E.164 international format numbers

Two-way SMS for US/ Canadian

...

DIDs

Requirements

  • Min. supported versions: 
    • WMS: 5.03.20210826.1
    • iOS mobile app: 8.1.45805
    • Android mobile app: 5.02.06
  • The USA Country Code (+1) set in WMS Settings -> PBX -> Language and Region

...

Code Block
smsEnabled=yes 

...

Usage

Two-way SMS via CLASSOUND is possible for US/ Canadian DIDs

...

The outgoing SMS can be sent internationally. Incoming SMS are not available in this case. 

Wildix PBX supports multiple ways of sending SMS and accessing SMS functionality in Collaboration. See some options of sending SMS below: 

a) for sending and receiving SMS within the USA or Canada respectively:

  1. Enter/ select a phone number in

...

  1. Collaboration Search field -> click2 Way SMS: [number]

...

b) Click the Add button -> Send SMS -> fill out Mobile number (you can enter multiple numbers) and Message fields, use Postpone delivery if needed -> click Send.

The following logic of sending SMS applies:

  1. If CURL request is configured, it has the first priority
  2. Otherwise, the system checks if there is a GSM gateway and uses it instead
  3. If neither CURL nor GSM gateway are configured, the system sends SMS via CLASSOUND

With CLASSOUND, a package of 200 SMS per each user is provided by default. Once the package is used, a fee is charged for each SMS sent. You can check the fee on WMP -> Price list -> CLASSOUND

Note

Note: For the Sender ID the system automatically takes user’s full name from WMS -> Users -> Full Name column. The maximum length of a Sender ID is 11 characters including spaces. If the name is longer, extra characters are cut off. 

Warning

Current limitation:

Sending links in SMS may be restricted. 

It is also possible to send mass outgoing SMS via API. Check the relevant section of this guide for detailed instructions: Mass SMS sending via API.

Two-way SMS for US/ Canadian DIDs

Two-way SMS via CLASSOUND is possible for US/ Canadian DIDs for sending and receiving SMS within the USA or Canada respectively:

Enter/ select a phone number in Collaboration Search field -> click 2 Way SMS: [number].

...

When an external user sends an SMS message to the company DID number (activated via CLASSOUND service), a group chat is automatically created, too. It includes PBX users who matched according to the Dialplan procedure or those who match licenses and Office number requirements; the conference title coincides a DID number from which messages are sent:

Dialplan configuration (optional)

Go to WMS -> Dialplan -> Dialplan rules and create a procedure "kite-sms".

...

Add Call group Dialplan application

Note

Note: All the Call group members should be static and assigned a UC-Business license (or higher) and have CLASSOUND DID as Office number.

Note

You can create a separate Dialplan procedure for managing SMS exchange, but messages can be delivered even without it, because initially the system finds the full match for the CLASSOUND DID (including +) and static Call group members with at least UC-Business license. If at least one user is found, a group chat is automatically created. Otherwise, the system searches users in the LDAP who have the CLASSOUND DID specified as their Office number. 

Warning

Limitations:

  • Not supported in WMS Network for users who are moved from PBX A to PBX B or who log in to another PBX from WMS Network (not the one they reside on)
  • Only static members of a Call group are added to a group chat

Two-way SMS for UK DIDs

Requirements

...

  • WMS: 5.03.20210826.1
  • iOS mobile app: 8.1.45805
  • Android mobile app: 5.02.06

...

 Two-way SMS via CLASSOUND allows both sending and receiving SMS within the UK:

Enter/ select a phone number in Collaboration Search field -> click 2 Way SMS: [number].

...

A group chat is automatically created, which includes the PBX user who is sending the SMS and the receiver. You can manage it as an ordinary group chat: change the title, add/ remove participants (you can find details in Collaboration User Guide).

...

  1. .


  2. A group chat is automatically created, which includes the PBX user who is sending the SMS and the receiver. You can manage it as an ordinary group chat: change the title, add/ remove participants (you can find details in Collaboration User Guide).

When an external user sends an SMS message to the company DID number (activated via CLASSOUND service), a group chat is automatically created, too. It includes PBX users who matched according to the Dialplan procedure or those who match licenses and Office number requirements; the conference title coincides a DID number from which messages are sent:


Dialplan configuration (optional)

Go to WMS -> Dialplan -> Dialplan rules and create a procedure "kite-sms".

  • Use CLASSOUND DID as a called number 
  • Add Call group Dialplan application

    Note

    Note: All the Call group members should be static and assigned a UC-Business license (or higher) and have CLASSOUND DID as Office number.



Note

You can create a separate Dialplan procedure for managing SMS exchange, but messages can be delivered even without it, because initially the system finds the full match for the CLASSOUND DID (including +) and static Call group members with at least UC-Business license. If at least one user is found, a group chat is automatically created. Otherwise, the system searches users in the LDAP who have the CLASSOUND DID specified as their Office number. 


Warning

Limitations:

  • Not supported in WMS Network for users who are moved from PBX A to PBX B or who log in to another PBX from WMS Network (not the one they reside on)
  • Only static members of a Call group are added to a group chat

Two-way SMS for UK DIDs

Requirements

  • Min. supported versions: 
    • WMS: 5.03.20210826.1
    • iOS mobile app: 8.1.45805
    • Android mobile app: 5.02.06
  • The UK Country Code (+44) set in WMS Settings -> PBX -> Language and Region
  • Available for numbers with allowed area codes(see the list here)and new mobile numbers: United Kingdom (2-way SMS) CLASSOUND DIDs


Usage

Two-way SMS via CLASSOUND allows both sending and receiving SMS within the UK:

  1. Enter/ select a phone number in Collaboration Search field -> click 2 Way SMS: [number].


  2. A group chat is automatically created, which includes the PBX user who is sending the SMS and the receiver. You can manage it as an ordinary group chat: change the title, add/ remove participants (you can find details in Collaboration User Guide).

When an external user sends an SMS message to the company DID number (activated via CLASSOUND service), a group chat is automatically created, too. It includes PBX users who matched according to the Dialplan procedure or those who match licenses and Office number requirements; the conference title coincides a DID number from which messages are sent:


Dialplan configuration (optional)

Go to WMS -> Dialplan -> Dialplan rules and create a procedure "kite-sms".

  • Use CLASSOUND DID as a called number 
  • Add Call group Dialplan application

    Note

    Note: All the Call group members should be static and assigned a UC-Business license (or higher) and have CLASSOUND DID as Office number.



Note

You can create a separate Dialplan procedure for managing SMS exchange, but messages can be delivered even without it, because initially the system finds the full match for the CLASSOUND DID (including +) and static Call group members with at least UC-Business license. If at least one user is found, a group chat is automatically created. Otherwise, the system searches users in the LDAP who have the CLASSOUND DID specified as their Office number. 


Warning

Limitations:

  • Not supported in WMS Network for users who are moved from PBX A to PBX B or who log in to another PBX from WMS Network (not the one they reside on)
  • Only static members of a Call group are added to a group chat

Outbound SMS

Prerequisites

General Requirements

  • Activated CLASSOUND 

  • Min. license type: UC-Essential or higher
Warning

Important: SMS can be sent only to E.164 international format numbers

Outgoing SMS for US/ Canadian DIDs 

Requirements

  • Min. supported versions: 
    • WMS: 5.03.20210826.1
    • iOS mobile app: 8.1.45805
    • Android mobile app: 5.02.06
  • The USA Country Code (+1) set in WMS Settings -> PBX -> Language and Region


Starting from WMS version 5.03.20210826.1, the feature is activated by default for PBXs with the USA Country Code. Prior to WMS version 5.03.20210826.1, you need to activate it by adding the following line to the config file/rw2/etc/pbx/groupChat.conf

Code Block
smsEnabled=yes 

The outgoing SMS can be sent internationally. Incoming SMS are not available in this case. 

Wildix PBX supports multiple ways of sending SMS and accessing SMS functionality in Collaboration. See some options of sending SMS below: 

a) Enter/ select a phone number in the Search field -> click SMS: [number]. It can be a contact from your Phonebooks or just an external number.

b) Click the Add button -> Send SMS -> fill out Mobile number (you can enter multiple numbers) and Message fields, use Postpone delivery if needed -> click Send.

The following logic of sending SMS applies:

  1. If CURL request is configured, it has the first priority
  2. Otherwise, the system checks if there is a GSM gateway and uses it instead
  3. If neither CURL nor GSM gateway are configured, the system sends SMS via CLASSOUND

With CLASSOUND, a package of 200 SMS per each user is provided by default. Once the package is used, a fee is charged for each SMS sent. The same fee as for calls is applied (CallTerminationArea_1). You can check the fee on WMP -> Price list -> CLASSOUND

Note

Note: For the Sender ID the system automatically takes user’s full name from WMS -> Users -> Full Name column. The maximum length of a Sender ID is 11 characters including spaces. If the name is longer, extra characters are cut off. 


Warning

Current limitation:

Sending links in SMS may be restricted. 

It is also possible to send mass outgoing SMS via API. Check the relevant section of this guide for detailed instructions: Mass SMS sending via API.

SMS for other DIDs (e.g. European DIDs)

Sending SMS is possible both within the country and internationally, e.g. from German DID to French number, etc. 

...

With CLASSOUND, a package of 200 SMS per each user per month is provided by default. Once the package is used, a fee is charged for each SMS sent. The same fee as for calls is applied (CallTerminationArea_1). You can check the fee on WMP -> Price list -> CLASSOUND. 

...

Note

Notes: 

  • Only outgoing SMS are supported.
  • To provide possibility for clients to contact back the sender, you can add Kite link to the SMS message. Kite documentation: Wildix WebRTC Kite - Admin Guide: Create Kite link
  • If you want to change sender name (User Name), you can do it in 2 ways: 
    • Manually: change name of relevant user in WMS -> Users
    • Automatically via API: https://{domain}/api/v1/doc/#operation/updatePBXColleague 
      API documentation can be accessed via PBX or by the link: https://www.wildix.com/wp-content/wms-api/.
    • For accessing API, UC-Business license is required. 

Sending bulk SMS via Collaboration

...