Search Message logs

This document will go over how to search your message logs.

GET /message

Search message logs will allow you to search for any messages between two set dates.

Curl

curl -X GET \
"https://api.mobivatebulksms.com/message?startDate=2023-01-01&endDate=2023-01-02&pageSize=100" \
-H 'Authorization: Bearer [API Key]'

Python

import requests

headers = {
    'Authorization': 'Bearer [API Key]',
}

params = {
    'startDate': '2023-01-01',
    'endDate': '2023-01-02',
    'pageSize': '100',
}

response = requests.get('https://api.mobivatebulksms.com/message', params=params, headers=headers)

Retrieve 100 Messages between 2023-01-01 00:00:00 (UTC) and 2023-01-02 00:00:00 (UTC):

Curl

curl -X GET \
"https://api.mobivatebulksms.com/message?startDate=2023-01-01&endDate=2023-01-02&pageSize=100" \
-H 'Authorization: Bearer [API Key]'

Python

import requests

headers = {
    'Authorization': 'Bearer [API Key]',
}

params = {
    'startDate': '2023-01-01',
    'endDate': '2023-01-02',
    'pageSize': '100',
}

response = requests.get('https://api.mobivatebulksms.com/message', params=params, headers=headers)

Retrieve Messages between 2023-01-01 12:00:00 (AEST) and 2023-01-02 12:00:00 (AEST):

Curl

curl -X GET \
"https://api.mobivatebulksms.com/message?startDate=2023-01-01T12:00:00%2B1200&endDate=2023-01-02T12:00:00%2B1200" \
-H 'Authorization: Bearer [API Key]'

Python

import requests

headers = {
    'Authorization': 'Bearer [API Key]',
}

response = requests.get(
    'https://api.mobivatebulksms.com/message?startDate=2023-01-01T12:00:00%2B1200&endDate=2023-01-02T12:00:00%2B1200',
    headers=headers,
)

Retrieve Incoming Messages between 2023-01-01 and 2023-01-02:

Curl

curl -X GET \
"https://api.mobivatebulksms.com/message?startDate=2023-01-01&endDate=2023-01-02&direction=MO" \
-H 'Authorization: Bearer [API Key]'

Python

import requests

headers = {
    'Authorization': 'Bearer [API Key]',
}

params = {
    'startDate': '2023-01-01',
    'endDate': '2023-01-02',
    'direction': 'MO',
}

response = requests.get('https://api.mobivatebulksms.com/message', params=params, headers=headers)

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer [API Key]

Body

Name	Type	Required?	Description
startDate	string	Yes	Start Date Format(s): YYYY-MM-DD YYYY-MM-DDTHH:MM:SS+TZ Examples: 2023-01-01 2023-01-01T00:00:00+0000 2023-01-01T00:09:00+0900.
endDate	string	Yes	End Date. Examples: See startDate.
page	integer	No	Page number. Default: 1.
pageSize	integer	No	Number of message records to return. Default: 10 Max: 1000.
direction	string	No	By default we'll retrieve both Mobile Originated (MO / Incoming) and Mobile Terminated (MT / Outgoing) messages. Optional Values: MO or MT.

Response

Upon a successful send request, our server will respond with a 200 (success) HTTP response code, and respond with an array of messages.

200

[
   {
      "id":"9A0C23DD0A000A9D2FBD4671D780AFDA",
      "created":"2023-07-01T01:10:34+0000",
      "modified":"2023-07-01T01:10:39+0000",
      "originator":"Sender ID",
      "recipient":"4400011223",
      "body":"Test Message 1",
      "status":"DELIVERED",
      "direction":"MT",
      "inReplyTo":null,
      "routeId":"mglobal",
      "parts":1,
      "cost":0.01,
      "currency":"GBP",
      "senderReference":"ref-001",
      "campaignId":null
   },
   {
      "id":"9A70B34A0A000A9D2FBD46712E56AB02",
      "created":"2023-07-01T03:00:24+0000",
      "modified":"2023-07-01T03:00:29+0000",
      "originator":"Brand",
      "recipient":"4400011223",
      "body":"Test Message 2",
      "status":"DELIVERED",
      "direction":"MT",
      "inReplyTo":null,
      "routeId":"FFBB2AA70A931B3100A1223E5804510B",
      "parts":1,
      "cost":0.02,
      "currency":"GBP",
      "senderReference":null,
      "campaignId":"9A70B2FE0A000A9D2FBD4671B0E64F3D"
   }
]

200 (No messages)

[
]

400

{
   "code":400,
   "message":"startDate: Invalid format: \"2023-01-011\" is malformed at \"1\""
}

401

{
   "code":401,
   "message":"Unauthorized"
}

We use conventional HTTP response codes to indicate the success or failure of an API request. In general:

2xx indicate success 4xx indicate an error that failed given the information provided (e.g., a required parameter was omitted) 5xx errors indicate an error with ours servers (these are rare).

To see a full list of our Response codes, please click here.