PHP SDK

Setup & Initialization

1. Install Package:

composer require pingram/php

2. Import:

use Pingram\Client;

3. Initialize:

$client = new Pingram\Client('YOUR_API_KEY');

* required

Region specific example:

use Pingram\Client;

$client = new Pingram\Client('YOUR_API_KEY', 'https://api.eu.pingram.io');

Send

send()

Send a notification

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\SenderPostBody(); // configure as needed

try {
    $result = $client->send($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling send: ', $e->getMessage(), PHP_EOL;
}

Parameters

Request Body Properties

Return Type

PingramModelSenderPostResponse

Domains

domainsAddDomain()

Request to verify a new sender domain

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\PostSendersRequestBody(); // configure as needed

try {
    $result = $client->getDomainsApi()->domainsAddDomain($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling domainsAddDomain: ', $e->getMessage(), PHP_EOL;
}

Parameters

Request Body Properties

Return Type

[PingramModelGetSendersResponseInner[]](../Model/GetSendersResponseInner.md)

domainsDeleteDomain()

Delete a sender domain or email address

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');

try {
    $result = $client->getDomainsApi()->domainsDeleteDomain();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling domainsDeleteDomain: ', $e->getMessage(), PHP_EOL;
}

Parameters

Return Type

PingramModelSuccessResponse

domainsListDomains()

Get all sender domains configured for the account

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');

try {
    $result = $client->getDomainsApi()->domainsListDomains();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling domainsListDomains: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return Type

[PingramModelGetSendersResponseInner[]](../Model/GetSendersResponseInner.md)

Environments

environmentsCreateEnvironment()

Create a new environment for the account

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\EnvironmentCreateRequest(); // configure as needed

try {
    $result = $client->getEnvironmentsApi()->environmentsCreateEnvironment($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling environmentsCreateEnvironment: ', $e->getMessage(), PHP_EOL;
}

Parameters

Request Body Properties

Return Type

PingramModelEnvironment

environmentsListEnvironments()

Get all environments for the authenticated account

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');

try {
    $result = $client->getEnvironmentsApi()->environmentsListEnvironments();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling environmentsListEnvironments: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return Type

[PingramModelGetEnvironmentsResponseInner[]](../Model/GetEnvironmentsResponseInner.md)

environmentsUpdateEnvironment()

Update environment settings (title, secret, disable sending, secure mode)

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\EnvironmentPatchRequest(); // configure as needed

try {
    $result = $client->getEnvironmentsApi()->environmentsUpdateEnvironment($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling environmentsUpdateEnvironment: ', $e->getMessage(), PHP_EOL;
}

Parameters

Request Body Properties

Return Type

PingramModelEnvironment

Logs

logsGetLogRetention()

Get log retention period in days for the account

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');

try {
    $result = $client->getLogsApi()->logsGetLogRetention();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling logsGetLogRetention: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return Type

PingramModelLogsRetentionResponse

logsGetLogs()

List logs for the authenticated account

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');

try {
    $result = $client->getLogsApi()->logsGetLogs();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling logsGetLogs: ', $e->getMessage(), PHP_EOL;
}

Parameters

Return Type

PingramModelGetLogsResponse

logsGetLogsByTrackingIds()

Get logs by tracking IDs (comma-separated, max 25 IDs)

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');

try {
    $result = $client->getLogsApi()->logsGetLogsByTrackingIds();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling logsGetLogsByTrackingIds: ', $e->getMessage(), PHP_EOL;
}

Parameters

Return Type

PingramModelLogsGetResponse

logsGetLogsQueryResult()

Get results from a query ID

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');

try {
    $result = $client->getLogsApi()->logsGetLogsQueryResult();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling logsGetLogsQueryResult: ', $e->getMessage(), PHP_EOL;
}

Parameters

Return Type

PingramModelLogsQueryResultResponse

logsStartLogsQuery()

Start a log query and return query ID for asynchronous log searching

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\LogQueryPostBody(); // configure as needed

try {
    $result = $client->getLogsApi()->logsStartLogsQuery($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling logsStartLogsQuery: ', $e->getMessage(), PHP_EOL;
}

Parameters

Request Body Properties

Return Type

PingramModelLogsQueryResponse

logsTailLogs()

Get last 100 logs from the stream

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');

try {
    $result = $client->getLogsApi()->logsTailLogs();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling logsTailLogs: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return Type

PingramModelLogsTailResponse

Sender

senderDeleteSchedule()

Delete (unschedule) an already scheduled notification

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');

try {
    $result = $client->getSenderApi()->senderDeleteSchedule();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling senderDeleteSchedule: ', $e->getMessage(), PHP_EOL;
}

Parameters

Return Type

PingramModelMessageResponse

senderTestEmail()

Test the emailer with a sample email

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\PostEmailTestRequest(); // configure as needed

try {
    $result = $client->getSenderApi()->senderTestEmail($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling senderTestEmail: ', $e->getMessage(), PHP_EOL;
}

Parameters

Request Body Properties

Return Type

PingramModelPostEmailTestResponse

senderUpdateSchedule()

Update the body or schedule of an already scheduled notification.

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\SenderPostBody(); // configure as needed

try {
    $result = $client->getSenderApi()->senderUpdateSchedule($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling senderUpdateSchedule: ', $e->getMessage(), PHP_EOL;
}

Parameters

Request Body Properties

Return Type

PingramModelMessageResponse

Templates

templatesCreateTemplate()

Create a new template for a notification

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\TemplatePostRequest(); // configure as needed

try {
    $result = $client->getTemplatesApi()->templatesCreateTemplate($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling templatesCreateTemplate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Request Body Properties

Return Type

PingramModelTemplate

templatesDeleteTemplate()

Delete a template

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');

try {
    $result = $client->getTemplatesApi()->templatesDeleteTemplate();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling templatesDeleteTemplate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Return Type

void (empty response body)

templatesGetTemplate()

Get a single template by ID

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');

try {
    $result = $client->getTemplatesApi()->templatesGetTemplate();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling templatesGetTemplate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Return Type

PingramModelGetTemplatesResponse

templatesListTemplates()

List all templates for a notification and channel

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');

try {
    $result = $client->getTemplatesApi()->templatesListTemplates();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling templatesListTemplates: ', $e->getMessage(), PHP_EOL;
}

Parameters

Return Type

[PingramModelGetTemplatesListResponseInner[]](../Model/GetTemplatesListResponseInner.md)

templatesSetDefaultTemplate()

Set a template as default for specific delivery modes

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\SetDefaultTemplateRequest(); // configure as needed

try {
    $result = $client->getTemplatesApi()->templatesSetDefaultTemplate($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling templatesSetDefaultTemplate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Request Body Properties

Return Type

PingramModelTemplate

templatesUpdateTemplate()

Update a template’s properties

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\TemplatePatchRequest(); // configure as needed

try {
    $result = $client->getTemplatesApi()->templatesUpdateTemplate($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling templatesUpdateTemplate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Return Type

PingramModelTemplate

Types

typesCreateNotificationType()

Create a new notification

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\NotificationCreateRequest(); // configure as needed

try {
    $result = $client->getTypesApi()->typesCreateNotificationType($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling typesCreateNotificationType: ', $e->getMessage(), PHP_EOL;
}

Parameters

Request Body Properties

Return Type

PingramModelNotification

typesDeleteNotificationType()

Delete a notification

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');

try {
    $result = $client->getTypesApi()->typesDeleteNotificationType();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling typesDeleteNotificationType: ', $e->getMessage(), PHP_EOL;
}

Parameters

Return Type

void (empty response body)

typesGetNotificationType()

Get a specific notification by ID

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');

try {
    $result = $client->getTypesApi()->typesGetNotificationType();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling typesGetNotificationType: ', $e->getMessage(), PHP_EOL;
}

Parameters

Return Type

[PingramModelGetNotificationsResponseInner[]](../Model/GetNotificationsResponseInner.md)

typesListNotificationTypes()

Get all notifications for an account with their templates

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');

try {
    $result = $client->getTypesApi()->typesListNotificationTypes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling typesListNotificationTypes: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return Type

[PingramModelGetNotificationsResponseInner[]](../Model/GetNotificationsResponseInner.md)

typesUpdateNotificationType()

Update a notification’s settings

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\NotificationPatchRequest(); // configure as needed

try {
    $result = $client->getTypesApi()->typesUpdateNotificationType($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling typesUpdateNotificationType: ', $e->getMessage(), PHP_EOL;
}

Parameters

Request Body Properties

Return Type

PingramModelNotification

User

userGetAccountMetadata()

Get account-level metadata including logo, VAPID key, and web push status

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');

try {
    $result = $client->getUserApi()->userGetAccountMetadata();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling userGetAccountMetadata: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return Type

PingramModelGetAccountMetadataResponse

userGetAvailableSlackChannels()

Get list of Slack channels and users for the authenticated user

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');

try {
    $result = $client->getUserApi()->userGetAvailableSlackChannels();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling userGetAvailableSlackChannels: ', $e->getMessage(), PHP_EOL;
}

Parameters

Return Type

void (empty response body)

userGetInAppNotifications()

Get in-app notifications for a user

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');

try {
    $result = $client->getUserApi()->userGetInAppNotifications();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling userGetInAppNotifications: ', $e->getMessage(), PHP_EOL;
}

Parameters

Return Type

PingramModelGetInappNotificationsResponse

userGetInAppUnreadCount()

Get the count of unread in-app notifications for a user

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');

try {
    $result = $client->getUserApi()->userGetInAppUnreadCount();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling userGetInAppUnreadCount: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return Type

PingramModelInappUnreadCountResponse

userGetUser()

Get a user by ID. All users exist implicitly, returns basic user object if not found in DB.

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');

try {
    $result = $client->getUserApi()->userGetUser();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling userGetUser: ', $e->getMessage(), PHP_EOL;
}

Parameters

Return Type

PingramModelUser

userIdentify()

Create or update a user with the given ID. Updates lastSeenTime automatically.

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\PostUserRequest(); // configure as needed

try {
    $result = $client->getUserApi()->userIdentify($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling userIdentify: ', $e->getMessage(), PHP_EOL;
}

Parameters

Request Body Properties

Return Type

PingramModelUser

userMarkInAppNotificationsAsSeen()

Mark in-app web notifications as seen/read for a user

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\InAppNotificationUnreadClearRequest(); // configure as needed

try {
    $result = $client->getUserApi()->userMarkInAppNotificationsAsSeen($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling userMarkInAppNotificationsAsSeen: ', $e->getMessage(), PHP_EOL;
}

Parameters

Request Body Properties

Return Type

PingramModelSuccessResponse

userUpdateInAppNotificationStatus()

Update in-app web notification status (opened, archived, clicked, etc.)

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\InAppNotificationPatchRequest(); // configure as needed

try {
    $result = $client->getUserApi()->userUpdateInAppNotificationStatus($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling userUpdateInAppNotificationStatus: ', $e->getMessage(), PHP_EOL;
}

Parameters

Request Body Properties

Return Type

PingramModelSuccessResponse

Users

usersDeleteUser()

Delete a user and all associated data (in-app notifications, preferences, and user record)

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');

try {
    $result = $client->getUsersApi()->usersDeleteUser();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling usersDeleteUser: ', $e->getMessage(), PHP_EOL;
}

Parameters

Return Type

PingramModelDeleteUserResponse

usersListUsers()

Get all users for an environment with pagination support

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');

try {
    $result = $client->getUsersApi()->usersListUsers();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling usersListUsers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Return Type

PingramModelGetUsersResponse

usersRemoveUserFromSuppression()

Remove user suppression status for a specific channel

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Pingram\Client;

$client = new Client('YOUR_API_KEY');

try {
    $result = $client->getUsersApi()->usersRemoveUserFromSuppression();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling usersRemoveUserFromSuppression: ', $e->getMessage(), PHP_EOL;
}

Parameters

Return Type

PingramModelUserSuppressionDeleteResponse