API Report

POST

/api/report

Administration

Get Report with option: today, yesterday, 7days, month, month_back

Request

Body Params application/json

key

string

required

number

string

required

Default:

timeType

string

required

Examples:

todayyesterday7daysmonthmonth_back

keyword

string

optional

status

string

optional

Example

{
  "key": "XXX123XXX",
  "timeType": "today"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.omnichannelmessenger.com/api/report' \
--header 'Content-Type: application/json' \
--data-raw '{
    "key": "XXX123XXX",
    "timeType": "today"
}'

Responses

🟢200A User object

application/json

Body

status

string

optional

success or failed

message

string

optional

success
wrong_time_choose: time_choose not known
no_data: no transaction at that time

data

array [object {6}]

optional

content

string

optional

msgId

string

optional

messageType

string

optional

number

string

optional

status

string

optional

date

string

optional

Example

{
  "status": "string",
  "message": "string",
  "data": [
    {
      "content": "string",
      "msgId": "string",
      "messageType": "string",
      "number": "string",
      "status": "string",
      "date": "string"
    }
  ]
}

🟠403Key not valid

User Info

Purge The Report