Text message notification integration
Overview
WorldShare Circulation automatically generates text message notifications for your library patrons and delivers them as downloadable files.
To enable integration, follow the steps below:
- Arrange for messaging retrieval with your service provider.
- Note the character limit for your messaging system and the frequency of delivery.
- Enter the desired communication in the Text Message field of the desired Loan notification template for Next-Generation Notifications within OCLC Service Configuration. Refer to Templates, Loans for more information.
- Enable Messaging Integration via the Enable notification types screen within OCLC Service Configuration.
Once enabled:
Caution: Once enabled, the files will begin loading to your file exchange. Do not enable the Message Integration until a solution is in place with your messaging provider.
- The system will generate a .csv file that is updated every 10-20 minutes when new messages exist.
- Files are securely placed on your library's file exchange under the path /xfer/wms/out/circdata/notifications
Patron opt-in:
To receive messages, the patron must navigate to My Account, provide a mobile number, and opt into receiving library account updates by text message. Refer to My Account for more information.
- Text messages can be viewed in the patron history according to your library's configuration.
Retrieve your message files
OCLC supports secure SFTP for institutions to retrieve files from OCLC. Files can be retrieved using an open source SFTP client. FileZilla is recommended, as it works consistently with multiple operating systems. FileZilla is freely available from the web and can be found here. Contact OCLC Support for assistance with your SFTP credentials.
- Files are securely placed on your library's file exchange under the path /xfer/wms/out/circdata/notifications.
Most SMS providers accept CSV files with phone number and message columns. For specific import procedures, refer to your messaging service's documentation.
For more information, refer to Download files with SFTP.
Notification files
Notification files are delivered in CSV (Comma-Separated Values) format, which can be opened in Excel or imported directly into most messaging systems.
Files use a standardized naming pattern to help with identification:
- wms.[InstitutionSymbol].out-circ-notifications.[NotificationType].D[Date].T[Time].csv
Each CSV file contains the following columns:
Note: Only the Recipient Address and Message columns are required for sending notifications. All other information is provided for debugging and record-keeping purposes.
|
Column |
Description |
Example |
|---|---|---|
|
Notification Type |
The type of notification being sent |
LOAN_DUE_DATE_REMINDER |
|
Created Date/Time |
When the notification was generated (ISO-8601 format) |
2025-07-29T13:39:00Z |
|
Sending Institution |
Your institution's registry ID |
128364 |
|
Recipient Institution |
The recipient's institution registry ID |
128365 |
|
Recipient Address |
Phone number to send the message to |
415-273-9164 |
|
Address Type |
Always "Mobile Number" for text notifications |
Mobile Number |
|
Locale |
Language the message was generated in |
en-US |
|
Message |
The actual message text to send |
You have some items due to be returned soon. |