Introduction
- Home
- Introduction
Introduction to SMS API Partner
SMS shipments are made from the SMS Platform Partner. From the site, you have immediate access to our free API: allows you to easily integrate our SMS services to your website, software or CRM application in PHP, ASP, .NET, Java or any other language.
Settings
Each API request supports at least the following parameters :
| apiKey | API key from your account. You get it in your SMS Partner account |
|---|---|
| Optional settings | |
| _format | Response format. You have the choice between json and xml. By default, the response format is json. Exemple : https://api.smspartner.fr/v1/me?apiKey=YOUR_API_KEY&_format=json |
| _format | Content-Type |
|---|---|
| json | application/json |
| xml | application/xml |
You can, for example, format the SMS message to json or xml formats, but you must enter the header Content-Type accordingly :
|
1 2 3 4 5 6 7 8 |
POST /v1/send HTTP/1.1 Host: api.smspartner.fr Content-Type: application/json { "apiKey": "API_KEY", "phoneNumbers": "+33600000000", "message": "Hello world" } |
|
1 2 3 4 5 6 7 8 |
POST /v1/send HTTP/1.1 Host: api.smspartner.fr Content-Type: application/xml API_KEY +33600000000 Hello world |
Queries
All API requests must be sent to http://api.smspartner.fr/v1/command, command is the API call that you want to run with the parameters included in the body POST or the URL (GET).