Package io.sendon.contacts.request

Class GetBlocklistRequest

java.lang.Object

io.sendon.contacts.request.GetBlocklistRequest

public class GetBlocklistRequest
extends Object

Request object for retrieving blocklist entries with filtering and pagination. Represents the query parameters for blocklist retrieval API.

Field Summary

Fields

Modifier and Type	Field	Description
String[]	blockTypes	Array of block types to filter by.
Integer	cursor	Cursor for pagination.
String	endDate	End date for filtering in YYYY-MM-DD HH:mm:ss format.
String[]	kakaoChannelIds	Array of Kakao channel IDs to filter by.
Integer	limit	Maximum number of entries to retrieve per page.
String	senderNumber	Filter by specific sender number.
String	startDate	Start date for filtering in YYYY-MM-DD HH:mm:ss format.

Constructor Summary

Constructors

Constructor	Description
GetBlocklistRequest()
GetBlocklistRequest(Integer cursor, Integer limit)	Constructor for simple pagination.
GetBlocklistRequest(String senderNumber, String[] kakaoChannelIds, String[] blockTypes, String startDate, String endDate, Integer cursor, Integer limit)	Constructor with all parameters.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

senderNumber

public String senderNumber

Filter by specific sender number. If not provided, retrieves blocklist for all sender numbers.

kakaoChannelIds

public String[] kakaoChannelIds

Array of Kakao channel IDs to filter by. Only applicable for Kakao message blocklist.

blockTypes

public String[] blockTypes

Array of block types to filter by. Valid values: WEB, API, ARS

startDate

public String startDate

Start date for filtering in YYYY-MM-DD HH:mm:ss format. Filters blocklist entries created on or after this date.

endDate

public String endDate

End date for filtering in YYYY-MM-DD HH:mm:ss format. Filters blocklist entries created on or before this date.

cursor

public Integer cursor

Cursor for pagination. Use the cursor from previous response to get next page. Default is 0 for first page.

limit

public Integer limit

Maximum number of entries to retrieve per page. Default is 20, should not be set too high to avoid slow response.

Constructor Details

GetBlocklistRequest

public GetBlocklistRequest()

GetBlocklistRequest

public GetBlocklistRequest(Integer cursor,
 Integer limit)

Constructor for simple pagination.

Parameters:

cursor - The cursor for pagination

limit - The maximum number of entries to retrieve

GetBlocklistRequest

public GetBlocklistRequest(String senderNumber,
 String[] kakaoChannelIds,
 String[] blockTypes,
 String startDate,
 String endDate,
 Integer cursor,
 Integer limit)

Constructor with all parameters.

Parameters:

senderNumber - Filter by specific sender number

kakaoChannelIds - Array of Kakao channel IDs to filter by

blockTypes - Array of block types to filter by

startDate - Start date for filtering

endDate - End date for filtering

cursor - Cursor for pagination

limit - Maximum number of entries to retrieve