Powered by

• Laravel Framework v7.30.4
• SMSGlobal

To display a Swagger OpenAPI documentation of the /api endpoints.

Compiled documentation is available at URL

• /docs

YAML file for Swagger is available at URL

• /docs/yaml

About API

API endpoints ask a user to provide their API Keys that they have generated on SMSGlobal for their own accounts.

To send an SMS for a user.

• method: POST
• end point: /api/message
• body Json example: {"destination_number":"+61000000000","message":"This is an example message."} (please replace the example data with real values)
• authentication: "Basic Auth"
• status: functional

To list all the messages sent by the user.

• method: GET
• end point: /api/message
• query parameters: destination_number
• authentication: "Basic Auth"
• status: functional

API Specification

Request Headers

• "Content-Type" : "application/json"
• "Accept" : "application/json"
• "Host" : {calculated when request is sent}
• "Content-Length" : {calculated when request is sent}

Request Authorization

• Type : "Basic Auth"
• Username "take your REST API Key from SMSGlobal "
• Password "take your REST API Secret from SMSGlobal "