Tutorial: Setting up SMS sending

Serverless Authentication Setting up SMS sending

Some authentication-related functions may need sending SMS to users, when invoking the "phone" identity provider: Webcom.addAccount(), Webcom.sendOtp(), Webcom.sendVerificationCode().

Currently, Webcom may interface with the following implementations for sending SMS (all of them provided by Orange services), which require to be set up in the Webcom developer console:

You can choose the SMS platform that best suits your needs:

Setup Process Target Coverage Price Delivery time Additional features
Paddock
DEV		 ODI portal
quick manual validation		 Test only Orange countries¹
Orange MSISDN		 Free Very quick Limited to 1000 SMS/month and 3 SMS/second
Paddock
PROD		 ODI portal
manual validation for each selected country		 Production Orange countries¹
Orange MSISDN²		 Depends on the selected countries and targeted operators Very quick
Contact Every One Manual request to OBS Production³ All over the world
All operators		 Free until 1000 SMS/month
Charged by OBS beyond		 quite quick Customization of SMS sender

¹ Europe: France, Reunion, the Caribbean, Spain, Romania, Poland, Belgium, Luxembourg, Slovakia
  MEA: Morocco, Tunisia, Jordan, Egypt, Senegal, Guinea-Bissau, Guinea Conakry, Liberia, Côte d'Ivoire, Mali, Niger, Cameroon, Congo, Madagascar, Burkina Faso, Botswana

² It's possible to contract with a broker to extend to other operators

³ Available to non-Orange projects

Whatever the chosen SMS sending service(s), the first step is to request an account or application to its/their provider(s). This step is out of the scope of the Webcom product (click on the link in the table above and follow instructions).

The second step is then to set up the credentials associated with your account(s) or application(s) at the chosen SMS sending service(s) within the Webcom developer console. This step is specific to each service:

Setting up Paddock

  1. Log in the Orange Developer Inside portal, then click on the button "My apps" and select the application where you have subscribed the paddock service, called SMS MT [INTERNET] Orange MSISDN - DEV (for the development environment) or SMS MT Orange or Brokering PROD (for the production environment), or create a new one and subscribe to one of the SMS MT [INTERNET] Orange MSISDN or SMS MT Orange or Brokering PROD APIs.
    WARNING: You must ask for the INTERNET access to these APIs by sending an email to smsapi.support@orange.com (by default, the ODI portal only grants access from the intranet).

  2. In the "Details" section (top of the page), click on the "Show" button. Copy the displayed "Authorization header" field (excluding the "Basic " prefix, including space).

  3. Back to the Webcom developer console, open the "authentication" tab within your Webcom application.

  4. Check that the "phone" authentication mode is enabled (first top-left card) and go to the "phone" opened card.

  5. Open the "senders" section (if not already opened):

    • add a new "sender" ("+" button),
    • choose the "paddock" implementation,
    • paste the previously copied "Authorization header" into the "credentials" field (check that the "Basic " prefix of the pasted credentials has been removed),
    • in the "version" field, select "dev" for the SMS MT [INTERNET] Orange MSISDN - DEV API or "v1" for the SMS MT Orange or Brokering PROD API,
    • click on the "save" button.

Setting up CEO

  1. Follow the CEO subscription procedure to get an account

  2. Open the network tab of the development tools of your web browser ("F12" key on most popular browsers) and log in the Contact Every One portal.

  3. Spot the HTTP request on https://contact-everyone.orange-business.com/api/web/groups?ids=XXXXX and copy the XXXXX identifier. If you don't want to use your default CEO group, select the good one and spot the HTTP request again.

  4. Back to the Webcom developer console, open the "authentication" tab within your Webcom application.

  5. Check that the "phone" authentication mode is enabled (first top-left card) and go to the "phone" opened card.

  6. Open the "senders" section (if not already opened):

    • add a new "sender" ("+" button),
    • choose the "ceo" implementation,
    • paste the previously copied XXXXX identifier into the "groupId" field,
    • fill in the "username" and "password" fields with your CEO identifier and password,
    • you can optionally fill the "senderName" field with any sender name defined within your CEO account
    • click on the "save" button.
↑ ↑