Sign in

v1

latestOpenAPI 3.0.12026-07-2471135326.0 KB
MLog report

Getting Report (JSON)

get/v3/mlog

Query parameters

fromstring required
<p>The date and time is represented in UTC Zulu - ISO-8601 format (yyyy-mm-dd-Thh:mm:ss.ssZ) for the <b>Start</b> of the reporting period.</p> <p>For example: '2015-03-04T00:00:00.000Z'</p>
tostring required
<p>The date and time is represented in UTC Zulu - ISO-8601 format (yyyy-mm-dd-Thh:mm:ss.ssZ) for the <b>End</b> of the reporting period.</p> <p>This must be after the start period time you defined in the <code>'from'</code> parameter.</p> <p>For example: '2015-03-04T00:00:00.000Z'</p>
recipientstring
<p>Enter the recipient's phone number or email address according to the delivery channel the message was sent to.</p> <p>For SMS, WhatsApp or RCS, you need to provide the phone number of the recipient.</p> <p>For Email, you need to provide the email address of the recipient.</p>
campaignIDstring

Unique identifier of the broadcast.

channelstring
<p>Delivery channel from which the message was sent.</p> <p><ul><li><code>'S'</code>: SMS</li> <li><code>'E'</code>: Email</li><li><code>'W'</code>: WhatsApp</li> <li><code>'R'</code>: RCS</li></ul></p> <p><b>NOTE</b>: You can only filter by one channel. That is, you cannot get logs from two or more delivery channels in the same request.</p>
senderstring

Enter the sending identity (Sender) according to the delivery channel.

statusstring
<p>Status of the message.</p> <p>Each delivery channel has its own message status.</p> <p><b>NOTE</b>: To filter by more than 1 status, enter each status separated by comma (without spaces). For example: <code>SENT,EXPIRED</code></p>
limitinteger

Use limit operator to limit the number of records returned

skipinteger

Use skip operator to skip the specified number of records.

prettyboolean
<p>User-readable values</p> <p><ul><li><code>true</code>: Set the value parameter in true to return a response with user-readable values.</li> <li><code>false</code>: Set the value parameter in false to return a response with <b>non-user-readable</b> values.</li></ul></p>

Response

Report request received successfully

Example response

{
  "meta": {
    "timestamp": 1597166699457,
    "transactionId": "70169d77-c165-4795-9932-35b8a3af96fb",
    "explain": "a descriptive text"
  }
}