Inbound message

InboundYour URL, registered per number

We POST this body to the URL you register on a number in the portal, under Core-SMS → Manage Numbers → Receive to Webhook API. The URL is set per number, so different numbers can land in different systems. Return 200 to acknowledge the message.

What we send

The message that arrived on your number.

fromstringRequired

The number that sent the message.

Example: 14055551234

tostring[]Required

Your numbers that received it.

Example: ["13055551234"]

textstringRequired

The body of the message.

Example: This is a test

mediaUrlsstring[]

URLs of any images attached to the message.

Example: ["https://wiretaptelecom.com/assets/img/logo.png"]

referenceIdstring

Our id for the message.

Example: iosd84ndi9

Example payload

{
  "from": "14055551234",
  "to": [
    "13055551234"
  ],
  "text": "This is a test",
  "mediaUrls": [
    "https://wiretaptelecom.com/assets/img/logo.png"
  ],
  "referenceId": "iosd84ndi9"
}

What to return

200

Your server returns this code if it accepts the callback.

Doing this without code?

The same ground, covered from the portal and the PBX side.

Generated from the OpenAPI spec for Messaging API v1.0.0.