Difference between revisions of "API Method EventNotificationBulkCreate"
From Updox API
(→Field Validations) |
(→Field Validations) |
||
Line 20: | Line 20: | ||
==== deliveryDateTime ==== | ==== deliveryDateTime ==== | ||
− | * | + | * Not Required - This will default to the current date/time if not provided, hence the notification will be scheduled to be sent right away. |
** Date/Time Format: yyyy-MM-ddTHH:mm:ss | ** Date/Time Format: yyyy-MM-ddTHH:mm:ss | ||
*** Example: 2015-01-01T14:01:00 | *** Example: 2015-01-01T14:01:00 | ||
==== deliveryDestination ==== | ==== deliveryDestination ==== | ||
− | * | + | * Required - The destination must match the format associate with the delivery method. |
** Phone Number - The phone number can contain formatting, but the maximum number of digits is 10. This cannot be used, if a method of EMAIL is specified for the delivery method. | ** Phone Number - The phone number can contain formatting, but the maximum number of digits is 10. This cannot be used, if a method of EMAIL is specified for the delivery method. | ||
*** Example: 333-222-4567 resolves to 3332224567 | *** Example: 333-222-4567 resolves to 3332224567 | ||
Line 32: | Line 32: | ||
==== deliveryMethod ==== | ==== deliveryMethod ==== | ||
− | * | + | * Required - The method by which the notification will be delivered. The list of acceptable values include: |
** SMS - This is case insensitive and will specify that the notification is to be delivered via text messaging. | ** SMS - This is case insensitive and will specify that the notification is to be delivered via text messaging. | ||
Revision as of 16:22, 11 December 2015
Contents |
Description
The following describes the processes involved when sending bulk event notifications.
A bulk event notification consists of a JSON object populated with a list of:
- payload (the content of the notification) - internal id (an identification id specified by the requester) - delivery date/time - delivery method
Field Validations
payload
- Required - The content of payload cannot be empty, otherwise the notification will be considered invalid.
internalId
- Not Required - This field is here as a way for a requester to track their notifications being created.
deliveryDateTime
- Not Required - This will default to the current date/time if not provided, hence the notification will be scheduled to be sent right away.
- Date/Time Format: yyyy-MM-ddTHH:mm:ss
- Example: 2015-01-01T14:01:00
- Date/Time Format: yyyy-MM-ddTHH:mm:ss
deliveryDestination
- Required - The destination must match the format associate with the delivery method.
- Phone Number - The phone number can contain formatting, but the maximum number of digits is 10. This cannot be used, if a method of EMAIL is specified for the delivery method.
- Example: 333-222-4567 resolves to 3332224567
- Email Address - This must be a valid email address. This cannot be used, if a method of SMS is specified for the delivery method.
- Example: abc123@alphabet.com
- Phone Number - The phone number can contain formatting, but the maximum number of digits is 10. This cannot be used, if a method of EMAIL is specified for the delivery method.
deliveryMethod
- Required - The method by which the notification will be delivered. The list of acceptable values include:
- SMS - This is case insensitive and will specify that the notification is to be delivered via text messaging.
Prerequisites
1 This API call requires Vendor-level credentials. The credentials should be populated into the applicationId
and applicationPassword
fields of the auth
block:
{ ... "auth": { "applicationId": "vendorId", "applicationPassword": "vendorPassword", "accountId": "", "userId": "" } }
2 This API call requires a Practice/Account-level identifier. The identifier should be populated into the accountId
field of the auth
block:
{
...
"auth": {
"applicationId": "vendorId",
"applicationPassword": "vendorPassword",
"accountId": "practiceId",
"userId": ""
}
}