Package com.inttegro

Class Client.ChimesClient

java.lang.Object

com.inttegro.Client.ChimesClient

Enclosing class:

Client

public static class Client.ChimesClient
extends Object

Constructor Summary

Constructors

Constructor	Description
ChimesClient(Client client)

Method Summary

Modifier and Type	Method	Description
BroadcastDetail	broadcast(BroadcastChimeParams params)	Broadcasts a chime to multiple recipients (POST /chimes/broadcast).
Chime	lookup(String chimeId)	Retrieves the details of a previously sent chime by its ID (POST /chimes/lookup).
ChimePage	page(PageChimesParams params)
ScheduledChime	schedule(ScheduleChimeParams params)	Schedules a notification message for delivery at a specific time (POST /chimes/schedule).
Chime	send(SendChimeParams params)	Sends a notification message (chime) immediately to a single recipient (POST /chimes/send).

Methods inherited from class java.lang.Object

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

Constructor Details

ChimesClient

public ChimesClient(Client client)

Method Details

send

public Chime send(SendChimeParams params)
           throws IOException,
InterruptedException,
ApiException

Sends a notification message (chime) immediately to a single recipient (POST /chimes/send).

Delivers a chime via SMS or email using the specified or default transport mechanism. The chime is sent immediately and returns delivery status information.

Parameters:

params - chime parameters including recipient, message, and optional transport settings

Returns:

Chime with chime ID and delivery status

Throws:

IOException - if network communication fails

InterruptedException - if the request is interrupted

ApiException - if invalid parameters (400), unauthorized (401), or validation fails (422)

lookup

public Chime lookup(String chimeId)
             throws IOException,
InterruptedException,
ApiException

Retrieves the details of a previously sent chime by its ID (POST /chimes/lookup).

Returns full chime information including transmission status, delivery details, recipient, message content, and timestamps.

Parameters:

chimeId - unique identifier of the chime to lookup

Returns:

Chime containing chime details and delivery status

Throws:

IOException - if network communication fails

InterruptedException - if the request is interrupted

ApiException - if chime not found (404) or other API errors occur

schedule

public ScheduledChime schedule(ScheduleChimeParams params)
                        throws IOException,
InterruptedException,
ApiException

Schedules a notification message for delivery at a specific time (POST /chimes/schedule).

Can be sent to a single recipient or multiple recipients (broadcast). The chime will be delivered on or after the specified time. Scheduled chimes can be cancelled before delivery.

Parameters:

params - scheduling parameters including recipient(s), message, delivery time, and transport settings

Returns:

ScheduledChime with scheduled chime details

Throws:

IOException - if network communication fails

InterruptedException - if the request is interrupted

ApiException - if invalid parameters (400), unauthorized (401), or validation fails (422)

broadcast

public BroadcastDetail broadcast(BroadcastChimeParams params)
                          throws IOException,
InterruptedException,
ApiException

Broadcasts a chime to multiple recipients (POST /chimes/broadcast).

Queues a broadcast with a common message template and service context. Use broadcasts for marketing announcements or bulk notifications.

Parameters:

params - broadcast parameters including recipients and message template

Returns:

BroadcastDetail summary of the queued broadcast

Throws:

IOException - if network communication fails

InterruptedException - if the request is interrupted

ApiException - if invalid parameters (400), unauthorized (401), or validation fails (422)

page

public ChimePage page(PageChimesParams params)
               throws IOException,
InterruptedException,
ApiException

Throws:

IOException

InterruptedException

ApiException