Introduction
- Home
- Introduction
Introduction to SMS Partner’s API
SMS messages are sent from the SMS Partner platform. From the site, you have immediate access to our free API: it allows you to easily integrate our SMS services into your website, software or CRM application in PHP, ASP, .NET, Java or any other language.
Parameters
Each API request supports at least the following parameters:
apiKey | CAPI Key of your account. You get it in your SMS Partner account. |
---|---|
Optional parameters | |
_format | Format Format of the response. You can choose between json and xml. By default, the response format is json. Example : https://api.smspartner.fr/v1/me?apiKey=YOUR_API_KEY&_format=json |
_format | Content-Type |
---|---|
json | application/json |
xml | application/xml |
For example, you can format the SMS message in json or xml format, but you must fill in the Content-Type header 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 |
Requests
All API requests must be sent to http://api.smspartner.fr/v1/ordered
, ordered
is the API call you want to execute, with the parameters included in the body POST or URL (GET).
Download an example in PHP
Feel free to consult our SDKs available on this site.