Use this method to get access to all of your outbound and inbound SMS or MMS using a single API endpoint. Messages can be filtered by date, originating (SenderID) and destination phone numbers or message tag
. By default, the results are paginated, with 25 records per page.
This endpoint requires authentication.
GET /messages
Name | Description |
---|---|
sent_after Query Required | String Specify the start date of your search time range in the |
sent_before Query Required | String Specify the end date of your search time range in the |
type Query Required | String Filter messages by the direction of SMS traffic, i.e. inbound or outbound |
from Query | String Filter messages by SMS sender. For |
to Query | String Filter messages by destination phone number. For |
status Query | Filter messages by message delivery status. |
tag Query | String Filter messages by tag. For |
page Query | String Page requested |
per_page Query | String Number of records per page |
SMS and MMS messaging
HTTP Status Code | Error Description | Exception Class |
---|---|---|
400 | Request failed. One or more parameters are not valid | |
403 | Request failed. Outbound messaging service is disabled. | |
Default | Request failed. One or more parameters are not valid |
curl -X GET -G \
--url 'https://api.wavix.com/v2/messages' \
-H 'Accept: application/json' \
-d 'appid=your-API-key' \
-d 'sent_after=2021-04-10' \
-d 'sent_before=2021-04-13' \
-d 'type=outbound' \
-d 'from=441517010141' \
-d 'to=441517010141' \
-d 'tag=some%20external%20id' \
-d 'page=2' \
-d 'per_page=100'