Nifteem

Webhook for incoming message notification

View as Markdown
POST https://example.com/webhook/incoming-message
X api key

This webhook is triggered when the a new message is received.

*/*

Body Required

Payload for the incoming message callback

  • event string Required

    Values are DISPATCH_STATUS or INCOMING_MESSAGE.

  • sentDate string(date-time) Required

    Message date and time (UTC)

  • sender string Required

    Your sender the user replied to.

  • channel string Required

    Values are RCS, SMS, or WHATSAPP.

  • channelIdentifier string Required

    The user identifier for the current channel.

  • message object Required
    Hide message attributes Show message attributes object
    • type string Required

      Values are ACTION, FILE, LOCATION, OPTIN, or TEXT.

    • text string

      Message text (available for types TEXT, ACTION)

    • url string

      Resource URL (available for type=FILE)

    • contentType string

      Content Type (available for type=FILE)

    • filename string

      File name (available for type=FILE)

    • size integer(int64)

      Size in byte (available for type=FILE)

    • expirationDate string(date-time)

      Message date and time (UTC) (available for type=FILE)

    • ctaPayload string

      The call-to-action code (CTA) associated to the message. (available for type=ACTION)

    • latitude number(double)

      The latitude of the sent position (available for type=LOCATION).

    • longitude number(double)

      The longitude of the sent position (available for type=LOCATION).

Responses

  • 200

    Callback received successfully

POST Incoming Message Notification
Request examples
Text message 
{
  "event": "INCOMING_MESSAGE",
  "sender": "agentSender",
  "channel": "RCS",
  "message": {
    "text": "ok",
    "type": "TEXT"
  },
  "sentDate": "2025-11-07T16:08:08Z",
  "channelIdentifier": "+393470000000"
}
Action (call to action) 
{
  "event": "INCOMING_MESSAGE",
  "sender": "agentSender",
  "channel": "RCS",
  "message": {
    "text": "ok",
    "type": "ACTION",
    "ctaPayload": "cta-ok"
  },
  "sentDate": "2025-11-07T17:11:41Z",
  "channelIdentifier": "+393470000000"
}
File content (image, video or document) 
{
  "event": "INCOMING_MESSAGE",
  "sender": "agentSender",
  "channel": "RCS",
  "message": {
    "url": "https://nifteem.fra1.digitaloceanspaces.com/agentSender/public/user/0FHD7EK0YXNCB/inbound/media/image/0NH0JT8XXXXXX.jpg",
    "size": 230230,
    "type": "FILE",
    "filename": "5750742160634860617.jpg",
    "contentType": "image/jpeg",
    "expirationDate": "2025-12-10T16:56:02Z"
  },
  "sentDate": "2025-11-10T16:56:02Z",
  "channelIdentifier": "+393470000000"
}
Location coordinates 
{
  "event": "INCOMING_MESSAGE",
  "sender": "agentSender",
  "channel": "RCS",
  "message": {
    "type": "LOCATION",
    "latitude": 46.1606409,
    "longitude": 12.2323908
  },
  "sentDate": "2025-11-10T17:15:28Z",
  "channelIdentifier": "+393470000000"
}