📦
Mobivate Bulk API Documentation
  • 👋Welcome to BulkSMS
  • AUTHENTICATION & INTEGRATION
    • Getting started with Integration
      • Creating a New API Key
      • Get API Key
      • Test API Key
    • Registering Webhooks
      • Delivery Receipt Notification
      • Incoming Message Notification
      • Short URL Click Notification
    • Understanding Response Codes
  • USE CASES
    • Send Single SMS Message
      • Understanding SMS Response Codes
    • Send Batch SMS Messages
      • Understanding Batch SMS Response Codes
    • Search Message logs
    • Search for Single Message log
    • List OptOuts
    • Add an OptOut
    • Delete an OptOut
    • Frequently Asked Questions
  • 📚Integrations
    • Integrating Mobivate framework into your own application
    • Automate SMS messages using events through Zapier
    • Asynchronous Number Verification
    • Synchronous Number Verification
    • Adding / Removing Contacts
    • Creating New Contact Group
  • 🔓ARCHIVED DOCS
    • Sending simple Notification messages
    • Sending SMS from 3rd Party Providers
    • Sending Campaigns
Powered by GitBook
On this page
  • Headers
  • Arguments
  • Examples

Was this helpful?

  1. AUTHENTICATION & INTEGRATION
  2. Registering Webhooks

Short URL Click Notification

This document will go over receiving Short URL click messages notifications via our API.

When a recipient clicks on a URL thas has been shortened by the system, a notification will be POSTed to the specified webhook URL.

Headers

Header
Value

Content-Type

application/json

Arguments

Name
Type
Description

messageId

string

Incoming Message Id

mobile

string

Message Originator - The mobile which sent the message..

batchId

string

Message Recipient - The virtual number or shortcode that received the message.

clientRef

string

Message reference as set by the client.

browser

string

Device browser.

country

string

Detected country based on IP Address.

ipAddress

string

IP address of the device.

iso2l

string

Two letter country ISO code (e.g. UK).

os

string

Device operating system.

url

string

The original (long) URL.

Examples

{
   "mobile":"4400001234",
   "messageId":"9AEC3BB90A000A9D2FBD467178FF6827",
   "batchId":"9AEC3B590A000A9D2FBD4671C4D151BF",
   "clientRef":"ref-001",
   "browser":"Safari",
   "country":"United Kingdom",
   "ipAddress":"1.1.1.1",
   "iso2l":"UK",
   "os":"Mac OS X",
   "url":"http://vimeo.com/751393851?autoplay=1"
}
PreviousIncoming Message NotificationNextUnderstanding Response Codes

Last updated 1 year ago

Was this helpful?