API Reference

Unmatched Message Callbacks

An unmatched message is an SMS message that has been sent from a mobile device to our platform that does not match any current campaign or system keyword.

This callback is triggered when an unmatched message is detected.

🚧

Before you register...

Set up your endpoint before sending any callback configurations. Do not use a "fake" URL to test the configuration, as this will result in errors.

📘

Registration note

An unmatched message callback must be registered on the Vibes Platform primary account of a short code using the parent company key. Please reach out to your account manager or Vibes Customer Care if you have questions about the primary account.

Callback Configuration

When registering for this callback, your request body should look something like the below example. Please note that if you have multiple source codes associated with your account, you will need to configure each code separately.

{
    "callback_type": "unmatched_message_received",
    "event_type": "unmatched_message_received", //deprecated
    "unmatched_message_received": {
        "source_code": "52623",
        "country_code": "1"
    },
    "destination": {
        "url":"YOUR_DESTINATION_URL_W_HTTPS", /*Do not use a "fake" URL (such as google.com).*/
        "method": "POST",
        "content_type": "application/json"
    },
    "start_date": "2019-06-05T19:49:16Z",
    "end_date": "2021-01-01T00:00:00Z"
}

Callback Body

This callback includes the information on the participant and which source code they were attempting to reach.

{
  "event_id":"d4e1a58a-047f-483c-a66a-f0c769e8b8d0",   
  "callback_type":"unmatched_message_received",
  "event_type":"unmatched_message_received", //deprecated
  "event_date":"2019-06-04T20:05:47Z",
  "participant":{
        "mdn:"+13123454567",
        "carrier_id":"104"
    },
  "source_code":{
     "company_key":"vibes123",
     "code":"52623",
     "country_code":"44",
     "code_type":"SC",
     "default_response":"This is the default response message. Thanks",
     "response_sent":true
   },
  "message":"Hello, this is my message!",
  "message_id":"9815e089-7f4c-4f98-9bfb-6e2b6e8e8e96",
  "txn_id":"cfee05ea-fa82-4ee9-8d9c-704718822f38",
  "receipt_date":"2019-06-04T22:29:51+00:00"
}

Additional Resources