Getting started
Introduction
This API allows to send massively SMS to a list of numbers.
Before starting
This API requires a authentication with login/password for a messaging-pro client, before sending the SMS campaign a check is made on the customer account to verify the validity of its bundle and its balance
** / ! ** This API requires an OAuth 2.0 2-legged authentication. Please follow the method described here.
Endpoint
Authentication Endpoint : https://api.orange.cm/messaging/api/v1/authenticate
Send Simple SMS : https://api.orange.com/messaging/v1/sms/simple
Advanced description
A messaging-pro client use its bundle to send a sms campaign to liste of number.
API Description
Summary of resources
This API has one principal resource CampaignSMS. It represents an immediat sms campaign that will be sent to a list of recipients.
| Resource | Definitions |
|---|---|
| campaignTitle | Title of sms campaign (Title to be used on front application) |
| projectName | The name of project (Name to be used on front application) |
| messageContent | The content of the sms |
| recipients | List of recipients (MSISDN number) separated by ', |
The ressource to authenticate a customer is Login
| Resource | Definitions |
|---|---|
| username | User name of the customer |
| password | Password of the customer |
Summary of methods and URL
| Use case using the method | Method | URL |
|---|---|---|
| Authenticate Messaging Pro customer | POST | https://api.orange.cm/messaging/api/v1/authenticate |
| Send SMS Camapign | POST | https://api.orange.com/messaging/v1/sms/simple |
| Go up |
Summary of parameters
For Login Endpoint
| Name | Description | Type | Mandatory |
|---|---|---|---|
| username | User name of the customer | String | Yes |
| password | Password of the customer | String | Yes |
For Send SMS Endpoint
| Name | Description | Type | Mandatory |
|---|---|---|---|
| campaignTitle | Title of sms campaign | String | Yes |
| projectName | Name of SMS project | String | Yes |
| messageContent | ntSMS cont | String | Yes |
| recipients | List of recipients (msisdn number) | Array of String | Yes |
| Go up |
Authenticate User
Request
curl -i -X POST -H "Content-Type:application/json" https://api.orange.cm/messaging/api/v1/authenticate -d '{"username":"api_client","password":"pass"}'Response
200 OK
Content-Type: application/json {
"token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhcGlfY2xpZW50Iiwic2NvcGVzIjpbeyJhdXRob3JpdHkiOiJST0xFX0FETUlOIn1dLCJpc3MiOiJodHRwOi8vYXBpLm9yYW5nZS5jb20iLCJpYXQiOjE1MjQzODkxODEsImV4cCI6MTUyNDM5Mjc4MX0._-8Faq3__DxmLkZcwF0Uah1sQN8lqILa527TFEXIeNo"
}Fields description
| Field name | Type | Description |
|---|---|---|
| token | String | Token to use on the next call to Messaging Pro API |
Send Simple SMS Campaign
Request
curl -X POST \
https://api.orange.com/messaging/v1/sms/simple \
-H 'Authorization: Bearer iAze4QX6Fu8DSyQn3FAn1JDMxHC0' \
-H 'Content-Type: application/json' \
-H 'X-MSP-Authorization-Key: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhbWVuYWxsYSIsInNjb3BlcyI6W3siYXV0aG9yaXR5IjoiUk9MRV9BRE1JTiJ9XSwiaXNzIjoiaHR0cDovL2FwaS5vcmFuZ2UuY29tIiwiaWF0IjoxNTQ3MDQ4NTEyLCJleHAiOjE1NDcwNTIxMTJ9.8yxAJEdbtFw7YQ-CfH8mXp4TZ3ymv40VOlVQobCQnf0' \
-d '{
"campaignTitle": "09/01/2019",
"messageContent": "Hello World ! from OD",
"projectName": "AMEN",
"recipients": [
"+229988888"]
}
'Response
201 OK
Content-Type: application/json {}relatedParty : A related party defines party or party role linked to the bill
History of document
| Version of the document | modification date | description of modifications |
|---|---|---|
| 1.0 | 03/12/2018 | initialization |