Inttegro PHP SDK

Chimes
in package

Chimes resource for sending notifications via SMS and email.

Chimes deliver transactional messages to customers instantly. Use chimes for order confirmations, payment receipts, shipping updates, or custom notifications triggered by your application logic.

Tags
see
https://studio.inttegro.com/chimes

for detailed guides

Table of Contents

Methods

__construct()  : mixed
Creates the chimes resource client.
broadcast()  : CreationDetail
Broadcast a chime to multiple recipients.
lookup()  : Chime
Retrieve details of a previously sent chime.
page()  : Page
Retrieve a paginated list of chimes.
schedule()  : CreationDetail
Schedule a notification to be sent at a future time.
send()  : Chime
Send an immediate notification to a recipient via SMS or email.

Methods

__construct()

Creates the chimes resource client.

public __construct(HttpClient $http) : mixed
Parameters
$http : HttpClient

Shared authenticated HTTP transport used by this resource client.

broadcast()

Broadcast a chime to multiple recipients.

public broadcast(array<string, mixed> $payload) : CreationDetail

Queues a broadcast with a shared message template. Use broadcasts for marketing announcements or bulk notifications.

Parameters
$payload : array<string, mixed>

Broadcast parameters

  • recipients: array - List of recipient phone numbers or emails (required)
  • message_template: string - Message template to send (required)
  • service_name: string - Service initiating the broadcast (required)
  • sender: string - Sender identifier (optional)
  • purpose: string - Purpose of this broadcast (optional)
  • preferred_gateway: string - Preferred delivery gateway (optional)
  • request_meta: array - Request controls such as idempotency_key (optional)
Return values
CreationDetail —

Broadcast summary

lookup()

Retrieve details of a previously sent chime.

public lookup(string $chimeId) : Chime

Returns full chime information including recipient, message content, transport method, delivery status, and transmission timestamps. Use this to verify delivery or debug notification issues.

Parameters
$chimeId : string

Unique identifier of the chime to retrieve (required)

Tags
example

Lookup a chime

$chime = $client->chimes->lookup(
    'chm_abc123xyz789'
);

echo "Recipient type: {$chime->recipient->type}\n";
echo "Status: {$chime->transmission?->status}\n";
echo "Sent at: " . $chime->transmission?->sentAt?->format(DATE_RFC3339) . "\n";
see
https://studio.inttegro.com/chimes

for chime overview

Return values
Chime —

Complete chime object with delivery details

page()

Retrieve a paginated list of chimes.

public page([array<string, mixed> $payload = [] ]) : Page

Sends the documented request through the shared authenticated transport and hydrates the successful response into the declared return type.

Parameters
$payload : array<string, mixed> = []

Request fields keyed by the documented snake_case API names.

Return values
Page —

A typed page of matching chimes.

schedule()

Schedule a notification to be sent at a future time.

public schedule(array<string, mixed> $payload) : CreationDetail

Creates a chime that will be sent automatically at the specified timestamp. Use scheduled chimes for appointment reminders, subscription renewal notices, or time-delayed notifications.

Parameters
$payload : array<string, mixed>

Scheduled chime parameters

  • recipients: array - List of recipient phone numbers or emails (required)
  • full_message: string - Message content to send (required)
  • send_after: \DateTimeInterface - Time when the chime should be sent (required)
  • sender_id: string - Sender identifier (optional)
  • purpose: string - Purpose of this scheduled chime (optional)
Tags
example

Schedule SMS for tomorrow

$schedule = $client->chimes->schedule([
    'recipients' => ['+233541234567', 'user@example.com'],
    'full_message' => 'Your subscription renews tomorrow',
    'send_after' => '2025-12-21T09:00:00Z',
    'sender_id' => 'YourBrand'
]);

echo "Chime scheduled: {$schedule->id}\n";
echo "Will send at: " . $schedule->sendAfter->format(DATE_RFC3339) . "\n";
see
https://studio.inttegro.com/send-scheduled-notifications

for scheduling guide

Return values
CreationDetail —

Scheduled chime object with send time

send()

Send an immediate notification to a recipient via SMS or email.

public send(array<string, mixed> $payload) : Chime

Delivers a message using the specified transport method (sms or email). Messages are sent synchronously, and delivery status is returned in the response. Use chimes for time-sensitive notifications like OTPs, order confirmations, or payment receipts.

Parameters
$payload : array<string, mixed>

Chime parameters

  • recipient: string - Phone number (E.164 format) or email address (required)
  • message: string - Message content to send (required)
  • transport: string - Delivery method: 'sms' or 'email' (optional, auto-detected from recipient)
  • sender: string - Sender name/number for SMS or from-address for email (optional)
Tags
example

Send SMS notification

$chime = $client->chimes->send([
    'recipient' => '+233541234567',
    'message' => 'Your order #12345 has shipped!',
    'transport' => 'sms'
]);

echo "Chime sent: {$chime->id}\n";
echo "Status: {$chime->transmission?->status}\n";

Send email notification

$chime = $client->chimes->send([
    'recipient' => 'customer@example.com',
    'message' => 'Payment received for order #12345',
    'transport' => 'email'
]);
see
https://studio.inttegro.com/send-customer-notification

for notification guide

Return values
Chime —

Sent chime with delivery status

On this page

Search results