GET api/v{version}/NotificationTypes

Gets the list of Notfication Types that are available in the IVR System, if configured.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

The requested API version

 string

Required

Default value is 2.0

Body Parameters

None.

Response Information

Resource Description

Returns the list of notifications that a client may choose to receive as callbacks, and the different communication methods that are available for each type.

Collection of NotificationTypeInfo
NameDescriptionTypeAdditional information
Code

Gets or sets the code that can be used to identify the notification type.

 string

None.
Name

Gets or sets the friendly name of the notification type.

 string

None.
Methods

Gets or sets the list of supported notification methods (Voice, SMS, Email).

 Collection of NotificationMethod

None.

Response Formats

application/json, text/json, application/problem+json

Sample: 
[
  {
    "code": "TripBookConfirmation",
    "name": "Trip Booking Confirmation",
    "methods": [
      1,
      2
    ]
  },
  {
    "code": "TripCancelConfirmation",
    "name": "Trip Cancel Confirmation",
    "methods": [
      1,
      2
    ]
  },
  {
    "code": "ClientNoShow",
    "name": "Client No Show",
    "methods": [
      0,
      1,
      2
    ]
  },
  {
    "code": "TripReminder",
    "name": "Trip Reminder (Previous Day)",
    "methods": [
      0,
      1,
      2
    ]
  },
  {
    "code": "ImmArrReminder",
    "name": "Imminent Arrival Reminder",
    "methods": [
      0,
      1,
      2
    ]
  },
  {
    "code": "MassNotification",
    "name": "Mass Notification",
    "methods": [
      0,
      1,
      2
    ]
  }
]

application/xml, text/xml

Sample: 
<ArrayOfNotificationTypeInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <NotificationTypeInfo>
    <Code>TripBookConfirmation</Code>
    <Methods>
      <NotificationMethod>SMS</NotificationMethod>
      <NotificationMethod>Email</NotificationMethod>
    </Methods>
    <Name>Trip Booking Confirmation</Name>
  </NotificationTypeInfo>
  <NotificationTypeInfo>
    <Code>TripCancelConfirmation</Code>
    <Methods>
      <NotificationMethod>SMS</NotificationMethod>
      <NotificationMethod>Email</NotificationMethod>
    </Methods>
    <Name>Trip Cancel Confirmation</Name>
  </NotificationTypeInfo>
  <NotificationTypeInfo>
    <Code>ClientNoShow</Code>
    <Methods>
      <NotificationMethod>Voice</NotificationMethod>
      <NotificationMethod>SMS</NotificationMethod>
      <NotificationMethod>Email</NotificationMethod>
    </Methods>
    <Name>Client No Show</Name>
  </NotificationTypeInfo>
  <NotificationTypeInfo>
    <Code>TripReminder</Code>
    <Methods>
      <NotificationMethod>Voice</NotificationMethod>
      <NotificationMethod>SMS</NotificationMethod>
      <NotificationMethod>Email</NotificationMethod>
    </Methods>
    <Name>Trip Reminder (Previous Day)</Name>
  </NotificationTypeInfo>
  <NotificationTypeInfo>
    <Code>ImmArrReminder</Code>
    <Methods>
      <NotificationMethod>Voice</NotificationMethod>
      <NotificationMethod>SMS</NotificationMethod>
      <NotificationMethod>Email</NotificationMethod>
    </Methods>
    <Name>Imminent Arrival Reminder</Name>
  </NotificationTypeInfo>
  <NotificationTypeInfo>
    <Code>MassNotification</Code>
    <Methods>
      <NotificationMethod>Voice</NotificationMethod>
      <NotificationMethod>SMS</NotificationMethod>
      <NotificationMethod>Email</NotificationMethod>
    </Methods>
    <Name>Mass Notification</Name>
  </NotificationTypeInfo>
</ArrayOfNotificationTypeInfo>