API Docs

Our API and docs will be upgraded within the next week or so. Please do NOT spam requests too quickly. Please include a slight between requests as there is currently a 500 request per minute limit in place. Here are the docs: 

SMS Request
URL: http://sms.seatheroes.com/site/mo-request

Method: POST Request

api_key (required): enter API key from portal as a string (Pro users only): https://sms.seatheroes.com/client/reports/api

limit (optional): specify the number of messages to return as an integer. If not specified, the most recent 10 messages will be returned. There is a limit of 100. 

page (optional): specify from which page to return messages. If not specified, it will return page 1. Calculate offset using the formula ($page - 1) * $limit.

to_number (optional): specify the number from which you want to retrieve the message. 

Parameter Handling Summary: 

Limit Parameter Handling:

• Set a default limit of 10 if none is provided.

• Validate that limit is a numeric value between 1 and 100.

Page Parameter Handling:

• Set a default page of 1 if none is provided.

• Validate that page is a positive integer.

• Calculate offset using the formula ($page - 1) * $limit.

to_number Filtering:

• Retrieve the to_number from the request if it exists.

• Add an additional AND condition to the query to filter by to_number.

Sample request: 

Curl -i

http://sms.seatheroes.com/site/mo-request?api_key=XIXDDURsdfasdfi4OBKyyyUZjvuAr6M4

_r&limit=100

Best practice sample request: 

http://sms.seatheroes.com/site/mo-request?api_key=XIXDDURsdfasdfi4OBKyyyUZjvuAr6M4

_r&to_number=1234567899&limit=10

Response

Responses will be returned in JSON format.

from_number: the sender number

to_number: the recipient number (your Seat Heroes' number)

message: the sent text message

date_created: the date the message was received

Example

Success response

[{"from_number":"1212121","to_number":"8182182812","message":"hosh","date_created":"2021-10-16

10:33:56"}]

Failed request

{"status":0,"description":"Invalid Api Key provided"}