Playlists
Search Playlist
POST /integrations/playlists/search
Search within published playlists or access any playlist, regardless of state, by ID.
Request
Filter
- id – Playlist ID (matches complete IDs only)
- search – Search is performed across multiple fields: Playlist name, Playlist title, Playlist description, etc.
Pagination
- size – page size
- number – page number to return (zero-based)
- sort – results sort-by field
Sample Request
{
"filter": {
"id": "string",
"search": "string"
},
"page": {
"size": 0,
"number": 0
}
}
Response
items – array of playlists limited to requested page size.
- id – Playlist ID
- name – Playlist Name
- title – Playlist Title
- Description – Playlist description
- Url – Playlist base URL
- coverUrl – Cover image URL
totalCount – total number of playlists that meets search criteria
Sample Request
{
"items": [
{
"id": "string",
"name": "string",
"title": "string",
"description": "string",
"url": "string",
"coverUrl": "string"
}
],
"totalCount": 0
}
Send Playlist via SMS
POST /integrations/playlists/send/sms
Sends playlist via SMS to the recipient and adds a record to the history.
Playlist sending is an asynchronous operation and is queued after the endpoint call completes.
Request
- playlistId – ID of the Playlist to be sent
- contactId – ID of the recipient
Sample Request
{
"playlistId": "string",
"contactId": "string"
}
Response
- acceptedDate – the datetime the playlist send has been accepted to the asynchronous queue.
Sample Response
{
"acceptedDate": "2023-05-24T10:00:00.000Z"
}
Send Playlist via Email
POST /integrations/playlists/send/email
Sends playlist via Email to the recipient and adds a record to the history.
Playlist sending is an asynchronous operation and is queued after the endpoint call completes.
Request
- playlistId – ID of the Playlist to be sent
- contactId – ID of the recipient
Sample Request
{
"playlistId": "string",
"contactId": "string"
}
Response
- acceptedDate – the datetime the playlist send has been accepted to the asynchronous queue.
Sample Response
{
"acceptedDate": "2023-05-24T10:00:00.000Z"
}
Send Playlist via WhatsApp
POST /integrations/playlists/send/whatsapp
Sends playlist via WhatsApp to the recipient and adds a record to the history.
Playlist sending is an asynchronous operation and is queued after the endpoint call completes.
Request
- playlistId – ID of the Playlist to be sent
- contactId – ID of the recipient
Sample Request
{
"playlistId": "string",
"contactId": "string"
}
Response
- acceptedDate – the datetime the playlist send has been accepted to the asynchronous queue.
Sample Response
{
"acceptedDate": "2023-05-24T10:00:00.000Z"
}
Quick-send Playlist via SMS
POST /integrations/playlists/quick-send/sms
Quick-send does not send playlist via Nteraction, but instead logs information to playlist history that a playlist has been sent externally.
Quick-send returns SMS content, with Nteraction template wilcards pre-populated, ready to be sent from the calling system
Request
- playlistId – ID of the Playlist to be sent
- contactId – ID of the recipient
Sample Request
{
"playlistId": "string",
"contactId": "string"
}
Response
- content – SMS body content
- subject – SMS subject content (is applicable)
- error – returns content preparation errors
Sample Response
{
"content": "string",
"subject": "string",
"error": "string"
}
Quick-send Playlist via Email
POST /integrations/playlists/quick-send/email
Quick-send does not send a playlist via Nteraction, but instead logs information to playlist history that a playlist has been sent externally.
Quick-send returns email content, with Nteraction template wilcards pre-populated, ready to be sent from the calling system
Request
- playlistId – ID of the Playlist to be sent
- contactId – ID of the recipient
Sample Request
{
"playlistId": "string",
"contactId": "string"
}
Response
- content – Email body content
- subject – Email subject line
- error – returns content preparation errors
Sample Response
{
"content": "string",
"subject": "string",
"error": "string"
}
Quick-send Playlist via WhatsApp
POST /integrations/playlists/quick-send/whatsapp
Quick-send does not send a playlist via Nteraction, but instead logs information to playlist history that a playlist has been sent externally.
Quick-send returns email content, with Nteraction template wilcards pre-populated, ready to be sent from the calling system
Request
- playlistId – ID of the Playlist to be sent
- contactId – ID of the recipient
Sample Request
{
"playlistId": "string",
"contactId": "string"
}
Response
- content – Message body content
- subject – Message subject line
- error – returns content preparation errors
Sample Response
{
"content": "string",
"subject": "string",
"error": "string"
}
Bulk Send Playlist via SMS
POST /integrations/playlists/bulk-send/sms
Sends a Playlist via SMS to multiple recipients and adds corresponding record(s) to the history.
Playlist sending is an asynchronous operation and each send request is queued after the endpoint call completes.
Request
- playlistId – ID of the Playlist to be sent
- contactIds – Array of recipientIDs
Sample Request
{
"playlistId": "string",
"contactsIds": [
"string"
],
"channel": 0
}
Response
- acceptedDate – the datetime the playlist send has been accepted to the asynchronous queue.
Sample Response
{
"acceptedDate": "2023-05-24T10:00:00.000Z"
}
Bulk Send Playlist via Email
POST /integrations/playlists/bulk-send/email
Sends a Playlist via Email to multiple recipients and adds corresponding record(s) to the history.
Playlist sending is an asynchronous operation and each send request is queued after the endpoint call completes.
Request
- playlistId – ID of the Playlist to be sent
- contactIds – Array of recipientIDs
Sample Request
{
"playlistId": "string",
"contactsIds": [
"string"
],
"channel": 0
}
Response
- acceptedDate – the datetime the playlist send has been accepted to the asynchronous queue.
Sample Response
{
"acceptedDate": "2023-05-24T10:00:00.000Z"
}
Bulk Send Playlist via WhatsApp
POST /integrations/playlists/bulk-send/whatsapp
Sends a Playlist via Email to multiple recipients and adds corresponding record(s) to the history.
Playlist sending is an asynchronous operation and each send request is queued after the endpoint call completes.
Request
- playlistId – ID of the Playlist to be sent
- contactIds – Array of recipientIDs
Sample Request
{
"playlistId": "string",
"contactsIds": [
"string"
],
"channel": 0
}
Response
- acceptedDate – the datetime the playlist send has been accepted to the asynchronous queue.
Sample Response
{
"acceptedDate": "2023-05-24T10:00:00.000Z"
}
