Logo
Openapi.it Public API Documentation

Gateway SMS

Number of APIs: 7


This web service exposes REST calls to send text messages directly from our gateway

Contact Support: Name: Support


1. messages-{id}-recipients - {{baseUrl}}/messages/:id/recipients/

GET {{baseUrl}}/messages/:id/recipients/

This method allows you to see the recipients of a particular message



2. messages-{id}-recipients - {{baseUrl}}/messages/:id/recipients/:number

GET {{baseUrl}}/messages/:id/recipients/:number

This method allows you to see the specific recipient of a particular message



3. messages-{id} - {{baseUrl}}/messages/:id

GET {{baseUrl}}/messages/:id

This method allows you to see the single message related to the parameter passed in the path



4. messages-{id} - {{baseUrl}}/messages/:id

PUT {{baseUrl}}/messages/:id

If a message exists with 'transaction = true', this method allows integrating the initial POST call (adding recipients for example) until a PUT with 'transaction = false' is passed. At that point the message is closed and put in the sending queue. With this method you can also change the sending date of the message ('timestamp_send') (if it hasn't already been sent or scheduled for sending).



5. messages-{id} - {{baseUrl}}/messages/:id

DELETE {{baseUrl}}/messages/:id

This method allows you to cancel and therefore not send a message (not allowed on messages already sent or scheduled for sending). With the cancellation there is no refund on the spent credits.



6. messages - {{baseUrl}}/messages/

GET {{baseUrl}}/messages/

This method allows you to view the list of sent messages from your account



7. messages - {{baseUrl}}/messages/

POST {{baseUrl}}/messages/

This method allows you to send an sms message directly from our gateway



ENDPOINTS