ℹ️ The Auron SMS Server is now Auron Omni. Learn more here.

How can we help?

Base URL and security

This is the API reference for the HTTP REST API channel.

Find out more about the HTTP REST API channel type and its features here.

Base URL for your channel

The base URL to use the REST API after configuring a channel takes this form:

https://127.0.0.1:7000/HTTP_API1/

Where:

  • https is the protocol (http or https)
  • 127.0.0.1 is the IP address or hostname associated with the IP address
  • 7000 is the port number
  • HTTP_API1 is the channel ID

Use the URL file extension to indicate whether the result is formatted in XML or JSON.

Return version information in XML format:

https://127.0.0.1:7000/HTTP_API1/messagedb/version.xml

The same version information in JSON format:

https://127.0.0.1:7000/HTTP_API1/messagedb/version.json

Security settings

When using API key or token authorization, make sure the API key is included in the HTTP header when making a request. Use the Authorization HTTP header for this.

For example, if the API key is: c2267709-a8c8-4807-b815-18049af6f749

The authorization header should be:

Authorization: c2267709-a8c8-4807-b815-18049af6f749