SMS - Get started
Last updated
English
Last updated
API Swagger Documentation is available here :
Vortext API base path is located at :
All methods are relative to this URL.
For example if you want to get status of vortext, you have to use:
All requests to Vortext API is made by HTTP protocol, using TLSv1 transport encryption.
As for now, basic authentication is used for every request made to Vortext service. Each request is completely stateless, so you can use Vortext service with a simple line of curl. If you don’t know about basic authentication, it only needs a http request header 'Authorization' :
The credential used if username:password encoded in base 64. Most of libraries will simply let you provide username and password.
This API is aimed primarily to handle json messages in http request and response bodies.
Use Content-Type: application/json header to let Vortext service know your request body format.
Use Accept: application/json header to let Vortext service which format do you want for body response.
As json doesn’t support natively Date/Time, all parameters tagged as Date in this API are string with ISO8601 format :
where Z is timezone (like +0200).
Examples : 2016-06-01T12:27:19.000+0200.
For query parameters, don’t forget to url encode these parameters.
You can customize sender name of SMS, instead of a classic number such as "30180". To do so, please make a request in ITCare to our team by requesting this feature to be setup.
Once your account configured, all SMS sent will be with this sender name. As per now, it is not possible to have multiple sender name per account.
Optionnaly, you can add a metadata object to sms send request, to tag custom data for this message. The added tag will be retrieved when getting the detail of the SMS.
Exemple of SMS sending with a metadata tag :
{ "phoneNumber": "+3361127272727", "message": "Please call me", "metadata": { "myCustomerId": "123de32", "caller": "MyApp 2.2" } }
It is possible to receive PUSH responses (https REST call) as soon as a customer makes a response to a previously sent SMS. To activate this features, please make a request in ITCare to our team .
Here is the specifications of outbound request you will receive once activated :
Protocol
https
URL
<yours>
HTTP method
POST
Authentication
None
Content-Type
application/json
Message Body
{ "response": { "content": "Response of your customer", "answeredAt" : "2020-02-12T13:00:00.000+0000" }, "message": { }}
You can set limits to avoid multiple calls / bad loops and prevent some flooding :
total SMS sent by minute
total SMS sent by hour
To activate this features, please make a request in ITCare to our team.
for services hosted in cegedim.cloud datacenters.
for 3rd party applications reaching Vortext on the internet.