POST api/v1/notificationevents/callback

Callback Endpoint for events triggered by Request-Response SMS Notifications.

Request Information

URI Parameters

None.

Body Parameters

NotificationEventCallbackModel
NameDescriptionTypeAdditional information
Status

string

None.

MessageType

string

None.

InternalRequestId

string

None.

Identifiers

Collection of IdentifierModel

None.

PayloadReference

string

None.

RecipientReference

string

None.

ErrorMessages

Object

None.

Response

NotificationEventResponseModel

None.

ResponseType

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "MessageType": "sample string 2",
  "InternalRequestId": "sample string 3",
  "Identifiers": [
    {
      "System": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "System": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "PayloadReference": "sample string 4",
  "RecipientReference": "sample string 5",
  "ErrorMessages": {},
  "Response": {
    "Recipient": "sample string 1",
    "ResponseText": "sample string 2",
    "ReceivedDateTime": "2026-01-02T19:23:22.9183838-06:00"
  },
  "ResponseType": "sample string 7"
}

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.