Skip to main content

InspectDto

channelstringrequired

Possible values: [email, sms, whatsapp]

Example: sms
senderstringrequired

Possible values: non-empty and <= 512 characters

Example: +15551234567
subjectstring

Possible values: <= 1024 characters

Example: Your package could not be delivered
bodystringrequired

Possible values: non-empty and <= 50000 characters

Example: Click http://bit.ly/verify-now to reschedule your delivery.
metadata object

Free-form channel metadata

property name*any

Free-form channel metadata

attachments object[]
  • Array [
    • filenamestringrequired

    Possible values: <= 256 characters

    Example: invoice.pdf
    contentTypestringrequired

    Possible values: <= 128 characters

    Example: application/pdf
    contentBase64stringrequired

    base64-encoded attachment bytes

    Possible values: <= 16777216 characters

  • ]
    • asyncboolean

    Process asynchronously: returns 202 {jobId, filescan_job_ids} to poll (equivalent to ?async=true / Prefer: respond-async). Requests WITH attachments are ALWAYS async regardless of this flag.

    Example: false
    checkOffensiveLanguageboolean

    Also block messages containing offensive/foul language. Adds a separate billable line ($0.001/check). Default false.

    Example: false
    InspectDto
    {
      "channel": "sms",
      "sender": "+15551234567",
      "subject": "Your package could not be delivered",
      "body": "Click http://bit.ly/verify-now to reschedule your delivery.",
      "metadata": {},
      "attachments": [
        {
          "filename": "invoice.pdf",
          "contentType": "application/pdf",
          "contentBase64": "string"
        }
      ],
      "async": false,
      "checkOffensiveLanguage": false
    }