PHP SDK

Setup & Initialization

  1. Install Package:
composer require pingram/php
  1. Import:
use Pingram\Client;
  1. Initialize:
$client = new Pingram\Client('YOUR_API_KEY');
Name Type Description
api_key* string Your Pingram API key. You can get it from your dashboard under Environments.
base_url string Optional. Override the base URL. Use https://api.ca.pingram.io for the Canada region, and https://api.eu.pingram.io for the EU region. Default: US region.

* required

Region specific example:

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

Send

send()

Send a notification (email, SMS, etc.) to one user. Requires a notification type which categorizes this messages for future reporting, and channel-specific payloads such as email or sms. Recipient is specified with the to parameter. Returns a trackingId for error or delivery lookup through our Logs.

<?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

| Name | Type | Description | Notes | | –––––––––– | ——————————— | ——————————— | —– | — | | sender_post_body | \Pingram\Model\SenderPostBody | See Request Body Properties below | | |

Request Body Properties

Name Type Description
type string ID of the notification type (e.g. “welcome_email”). Creates a new notification if it does not exist.
to object Recipient user. Provide id, email, or number to identify the user.
to.id string Unique user identifier. Required.
to.email string User’s email address for email notifications.
to.number string User’s phone number for SMS/call notifications.
to.pushTokens object[] Mobile push tokens (FCM, APN) for push notifications.
to.pushTokens[].type “FCM” | “APN” (required)
to.pushTokens[].token string (required)
to.pushTokens[].device object (required)
to.pushTokens[].device.app_id string
to.pushTokens[].device.ad_id string
to.pushTokens[].device.device_id string (required)
to.pushTokens[].device.platform string
to.pushTokens[].device.manufacturer string
to.pushTokens[].device.model string
to.pushTokens[].environment string used by APN to differentiate between sandbox and production builds (sandbox/undefined or production)
to.webPushTokens object[] Web push subscription config from the browser.
to.webPushTokens[].sub object (required) Configuration for a Push Subscription. This can be obtained on the frontend by calling serviceWorkerRegistration.pushManager.subscribe(). The expected format is the same output as JSON.stringify’ing a PushSubscription in the browser.
to.webPushTokens[].sub.endpoint string (required)
to.webPushTokens[].sub.keys object (required)
to.webPushTokens[].sub.keys.p256dh string (required)
to.webPushTokens[].sub.keys.auth string (required)
to.timezone string User’s timezone (e.g. “America/New_York”) for scheduling.
to.slackChannel string The destination channel of slack notifications sent to this user. Can be either of the following: - Channel name, e.g. “test” - Channel name with # prefix, e.g. “#test” - Channel ID, e.g. “C1234567890” - User ID for DM, e.g. “U1234567890” - Username with @ prefix, e.g. “@test”
to.slackToken object
to.slackToken.access_token string
to.slackToken.app_id string
to.slackToken.authed_user object
to.slackToken.authed_user.access_token string
to.slackToken.authed_user.expires_in number
to.slackToken.authed_user.id string
to.slackToken.authed_user.refresh_token string
to.slackToken.authed_user.scope string
to.slackToken.authed_user.token_type string
to.slackToken.bot_user_id string
to.slackToken.enterprise object
to.slackToken.enterprise.id string
to.slackToken.enterprise.name string
to.slackToken.error string
to.slackToken.expires_in number
to.slackToken.incoming_webhook object
to.slackToken.incoming_webhook.channel string
to.slackToken.incoming_webhook.channel_id string
to.slackToken.incoming_webhook.configuration_url string
to.slackToken.incoming_webhook.url string
to.slackToken.is_enterprise_install boolean
to.slackToken.needed string
to.slackToken.ok boolean (required)
to.slackToken.provided string
to.slackToken.refresh_token string
to.slackToken.scope string
to.slackToken.team object
to.slackToken.team.id string
to.slackToken.team.name string
to.slackToken.token_type string
to.slackToken.warning string
to.slackToken.response_metadata object
to.slackToken.response_metadata.warnings string[]
to.slackToken.response_metadata.next_cursor string
to.slackToken.response_metadata.scopes string[]
to.slackToken.response_metadata.acceptedScopes string[]
to.slackToken.response_metadata.retryAfter number
to.slackToken.response_metadata.messages string[]
to.lastSeenTime string Last activity timestamp. Updated automatically. Read-only.
to.updatedAt string Last update timestamp. Read-only.
to.createdAt string Creation timestamp. Read-only.
to.emailSuppressionStatus object Bounce or complaint status if email was suppressed. Read-only.
to.emailSuppressionStatus.reason “Bounce” | “Complaint” (required)
to.emailSuppressionStatus.details object (required)
forceChannels (“EMAIL” | “INAPP_WEB” | “SMS” | “CALL” | “PUSH” | “WEB_PUSH” | “SLACK”)[] Override which channels to send to (e.g. [“EMAIL”, “SMS”]). Bypasses notification channel config.
parameters Record<string, any> Key-value pairs for template merge tags. Replaces placeholders like {{firstName}} in templates.
secondaryId string Optional sub-notification identifier for grouping or tracking.
templateId string Specific template ID to use. If omitted, uses the default template for each channel.
subNotificationId string Sub-notification identifier (e.g. for grouping related notifications).
options object Per-channel overrides for send options (email, APN, FCM).
options.email object Email-specific overrides.
options.email.replyToAddresses string[] Reply-to addresses for the email.
options.email.ccAddresses string[] CC recipients.
options.email.bccAddresses string[] BCC recipients.
options.email.fromAddress string Override sender email address.
options.email.fromName string Override sender display name.
options.email.attachments (object | object)[] File attachments (by URL or inline base64 content). Inline content: ~4 MB raw per file (413 if exceeded). URL url: up to 20 MB per file.
options.email.condition string Conditional expression for when to send (e.g. merge tag logic).
options.apn object Apple Push Notification (APN) overrides.
options.apn.expiry number Seconds until the notification expires.
options.apn.priority number Delivery priority (10 = immediate, 5 = power-saving).
options.apn.collapseId string Group notifications with the same ID (replaces previous).
options.apn.threadId string Thread identifier for grouping notifications.
options.apn.badge number Badge count on app icon.
options.apn.sound string Sound file name.
options.apn.contentAvailable boolean Silent background notification (no alert).
options.fcm object Firebase Cloud Messaging (FCM) overrides.
options.fcm.android object Android-specific FCM options.
options.fcm.android.collapseKey string Collapse key for grouping messages.
options.fcm.android.priority “high” | “normal” Delivery priority.
options.fcm.android.ttl number Time to live in seconds.
options.fcm.android.restrictedPackageName string Restrict delivery to a specific package.
options.push object Cross-platform mobile push options (applied to both APN and FCM).
options.push.customData Record<string, string> Up to 3 custom string key-value pairs for deep linking. Included in both APN and FCM payloads.
schedule string
email object Inline email content (subject, html). Use when not using templates.
email.subject string (required) Email subject line.
email.html string (required) HTML body content.
email.previewText string Preview/snippet text shown in inbox.
email.senderName string Display name of sender.
email.senderEmail string Sender email address.
inapp object Inline in-app content (title, url, image).
inapp.title string (required) Notification title.
inapp.url string URL to open when clicked.
inapp.image string Image URL.
sms object Inline SMS content (message, autoReply, from, mediaUrls).
sms.message string SMS/MMS body text.
sms.mediaUrls string[] Public HTTPS URLs of media to attach (MMS). Carriers fetch these via GET. Total size limits apply per provider.
sms.autoReply object
sms.autoReply.message string (required) Auto-reply message to send when user texts in.
sms.from string Override the sender phone number. Must be a verified number on your account.
call object Inline call content (message).
call.message string (required) Text to speak (TTS).
web_push object Inline web push content (title, message, icon, url).
web_push.title string (required) Notification title.
web_push.message string (required) Body text.
web_push.icon string Icon URL.
web_push.url string URL to open when clicked.
mobile_push object Inline mobile push content (title, message).
mobile_push.title string (required) Notification title.
mobile_push.message string (required) Body text.
slack object Inline Slack content (text, blocks, etc.).
slack.text string (required) Fallback plain text (required when using blocks).
slack.blocks Record<string, any>[] Slack Block Kit blocks.
slack.username string Override bot username.
slack.icon string Icon: emoji (e.g. “:smile:”) or URL. Default: bot’s icon.
slack.thread_ts string Parent message ts to post in a thread.
slack.reply_broadcast boolean When true with thread_ts, broadcasts reply to channel. Default: false.
slack.parse “full” | “none” URL parsing: “full” (clickable links) or “none”. Default: “none”.
slack.link_names boolean Convert channel and username refs to Slack links. Default: false.
slack.mrkdwn boolean Enable Slack markup (bold, italic, code). Default: true.
slack.unfurl_links boolean Unfurl link previews. Default: true.
slack.unfurl_media boolean Unfurl media previews. Default: true.
slack.metadata object Slack message metadata with optional work object entities. Combines standard Slack message metadata fields with an array of entity objects.
slack.metadata.entities object[] An array of work object entities.
slack.metadata.entities[].entity_type string (required) Entity type (e.g., ‘slack#/entities/task’, ‘slack#/entities/file’).
slack.metadata.entities[].entity_payload Record<string, any> (required) Schema for the given entity type.
slack.metadata.entities[].external_ref object (required) Reference used to identify an entity within the developer’s system.
slack.metadata.entities[].external_ref.id string (required)
slack.metadata.entities[].external_ref.type string
slack.metadata.entities[].url string (required) URL used to identify an entity within the developer’s system.
slack.metadata.entities[].app_unfurl_url string The exact URL posted in the source message. Required in metadata passed to chat.unfurl.
slack.metadata.event_type string A human readable alphanumeric string representing your application’s metadata event.
slack.metadata.event_payload Record<string, any> A free-form object containing whatever data your application wishes to attach to messages.

Return Type

PingramModelSenderPostResponse

Webhooks

webhooksDeleteEventsWebhook()

Delete the events webhook configuration for the current account/environment.

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
try {
$result = $client->getWebhooks()->webhooksDeleteEventsWebhook();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling webhooksDeleteEventsWebhook: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return Type

void (empty response body)

webhooksGetEventsWebhook()

Get the events webhook configuration for the current account/environment.

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
try {
$result = $client->getWebhooks()->webhooksGetEventsWebhook();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling webhooksGetEventsWebhook: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return Type

PingramModelEventsWebhookResponse

webhooksUpsertEventsWebhook()

Create or update the events webhook configuration for the current account/environment.

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\EventsWebhookUpsertRequest(); // configure as needed
try {
$result = $client->getWebhooks()->webhooksUpsertEventsWebhook($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling webhooksUpsertEventsWebhook: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | ——————————— | ——————————————— | ——————————— | —– | — | | events_webhook_upsert_request | \Pingram\Model\EventsWebhookUpsertRequest | See Request Body Properties below | | |

Request Body Properties

Name Type Description
webhook string (required) Destination URL that receives webhook event payloads. Must be a valid http(s) URL.
events (“EMAIL_OPEN” | “EMAIL_CLICK” | “EMAIL_FAILED” | “EMAIL_DELIVERED” | “EMAIL_UNSUBSCRIBE” | “EMAIL_INBOUND” | “INAPP_WEB_FAILED” | “INAPP_WEB_UNSUBSCRIBE” | “SMS_DELIVERED” | “SMS_FAILED” | “SMS_UNSUBSCRIBE” | “SMS_SUBSCRIBE” | “SMS_INBOUND” | “PUSH_FAILED” | “PUSH_UNSUBSCRIBE” | “CALL_FAILED” | “CALL_UNSUBSCRIBE” | “WEB_PUSH_FAILED” | “WEB_PUSH_UNSUBSCRIBE” | “SLACK_FAILED” | “SLACK_UNSUBSCRIBE” | “VOICE_INBOUND”)[] (required) List of event types that should be forwarded to the webhook URL.

Return Type

PingramModelEventsWebhookResponse

Addresses

addressesCreateAddress()

Create a new email inbox. Omit domain for a built-in @mail.pingram.io address; set domain and displayName for a custom address on a verified domain.

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\CreateAddressRequest(); // configure as needed
try {
$result = $client->getAddresses()->addressesCreateAddress($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling addressesCreateAddress: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | ––––––––––––– | ————————————— | ——————————— | —– | — | | create_address_request | \Pingram\Model\CreateAddressRequest | See Request Body Properties below | | |

Request Body Properties

Name Type Description
prefix string (required)
domain string
displayName string

Return Type

PingramModelAddressResponse

addressesDeleteAddress()

Delete a custom inbound address. Builtin addresses cannot be deleted.

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
try {
$result = $client->getAddresses()->addressesDeleteAddress();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling addressesDeleteAddress: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
full_address string Full address to delete (e.g. hello@example.com)

Return Type

PingramModelSuccessResponse

addressesListAddresses()

List email inboxes (addresses) configured for receiving. Custom addresses must use a verified domain.

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
try {
$result = $client->getAddresses()->addressesListAddresses();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling addressesListAddresses: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return Type

PingramModelAccountAddressesResponse

addressesUpdateAddress()

Update an inbox prefix or display name.

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\UpdateAddressRequest(); // configure as needed
try {
$result = $client->getAddresses()->addressesUpdateAddress($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling addressesUpdateAddress: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | ––––––––––––– | ————————————— | ——————————— | —– | — | | update_address_request | \Pingram\Model\UpdateAddressRequest | See Request Body Properties below | | |

Request Body Properties

Name Type Description
fullAddress string (required)
prefix string
displayName string

Return Type

PingramModelAddressResponse

Domains

domainsAddDomain()

Add and start verification for a new sender domain. Pass the domain only (not a full email address).

<?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->getDomains()->domainsAddDomain($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling domainsAddDomain: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | —————————– | —————————————– | ——————————— | —– | — | | post_senders_request_body | \Pingram\Model\PostSendersRequestBody | See Request Body Properties below | | |

Request Body Properties

Name Type Description
sender string (required)

Return Type

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

domainsDeleteDomain()

Remove a sender domain from the account.

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
try {
$result = $client->getDomains()->domainsDeleteDomain();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling domainsDeleteDomain: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
sender string Sender domain (URL encoded)

Return Type

PingramModelSuccessResponse

domainsListDomains()

List sender domains configured for the account (for outbound email).

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
try {
$result = $client->getDomains()->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)

domainsStartDomainVerification()

Start SES domain verification (DNS readiness is checked client-side via checkDomainDns)

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
try {
$result = $client->getDomains()->domainsStartDomainVerification();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling domainsStartDomainVerification: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
sender string Sender domain (URL encoded)

Return Type

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

Email

emailSend()

Send an email. Requires type, to, subject, and html. Optional: fromAddress, fromName, schedule, attachments. The fromAddress must be a verified domain; otherwise our built-in address will be used which is fine for testing purposes.

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\SendEmailRequest(); // configure as needed
try {
$result = $client->getEmail()->emailSend($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling emailSend: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | ––––––––––– | ———————————– | ——————————— | —– | — | | send_email_request | \Pingram\Model\SendEmailRequest | See Request Body Properties below | | |

Request Body Properties

Name Type Description
type string (required) The notification type to send.
to string (required) The email address of the recipient.
subject string (required) The subject of the email.
html string (required) The HTML body of the email.
fromName string The display name of the sender.
fromAddress string The email address of the sender.
previewText string The preview text of the email.
replyToAddresses string[] The reply-to addresses of the email.
ccAddresses string[] The CC addresses of the email.
bccAddresses string[] The BCC addresses of the email.
attachments object[] URL-based file attachments. Up to 20 MB per file.
attachments[].filename string (required)
attachments[].url string (required)
schedule string The ISO 8601 datetime to schedule the email.

Return Type

PingramModelSendEmailApiResponse

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->getEnvironments()->environmentsCreateEnvironment($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling environmentsCreateEnvironment: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | —————————— | —————————————–– | ——————————— | —– | — | | environment_create_request | \Pingram\Model\EnvironmentCreateRequest | See Request Body Properties below | | |

Request Body Properties

Name Type Description
title string (required)

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->getEnvironments()->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->getEnvironments()->environmentsUpdateEnvironment($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling environmentsUpdateEnvironment: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | —————————– | —————————————— | ——————————— | —– | — | | client_id | string | Environment client ID | | | environment_patch_request | \Pingram\Model\EnvironmentPatchRequest | See Request Body Properties below | | |

Request Body Properties

Name Type Description
resetSecret boolean
disableSending (“EMAIL” | “INAPP_WEB” | “SMS” | “CALL” | “PUSH” | “WEB_PUSH” | “SLACK”)[]
title string
secureMode boolean

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->getLogs()->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 recent notification logs for the authenticated account, newest first.

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
try {
$result = $client->getLogs()->logsGetLogs();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling logsGetLogs: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
limit float Maximum number of logs to return (default [optional]
cursor string Pagination cursor for next page [optional]

Return Type

PingramModelGetLogsResponse

logsGetLogsByTrackingIds()

Get logs by tracking IDs (comma-separated, max 25 IDs). Use after sending email or SMS to look up delivery status.

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
try {
$result = $client->getLogs()->logsGetLogsByTrackingIds();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling logsGetLogsByTrackingIds: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
tracking_ids string Comma-separated tracking IDs (URL encoded)

Return Type

PingramModelLogsGetResponse

logsGetLogsQueryResult()

Get results from a log query started with Start Log Query. Poll until status is Complete.

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
try {
$result = $client->getLogs()->logsGetLogsQueryResult();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling logsGetLogsQueryResult: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
query_id string Query ID returned by Start Log Query

Return Type

PingramModelLogsQueryResultResponse

logsStartLogsQuery()

Start an asynchronous log search over a date range. Returns a queryId; poll with Get Log Query Results until status is Complete.

<?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->getLogs()->logsStartLogsQuery($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling logsStartLogsQuery: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | ———————– | ———————————– | ——————————— | —– | — | | log_query_post_body | \Pingram\Model\LogQueryPostBody | See Request Body Properties below | | |

Request Body Properties

Name Type Description
dateRangeFilter number[] A tuple of [startTime, endTime] for the date range filter, each representing a unix timestamp.
userFilter string
envIdFilter string[]
statusFilter string
channelFilter (“email” | “inapp” | “sms” | “call” | “web_push” | “mobile_push” | “slack”)[]
notificationFilter string[]

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->getLogs()->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

Numbers

numbersList()

List active phone numbers registered for the account.

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
try {
$result = $client->getNumbers()->numbersList();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling numbersList: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return Type

PingramModelListPhoneNumbersResponse

numbersListReleased()

List released phone numbers. Released numbers may be purchased again with 2 weeks of being released. Released numbers may be removed from released list after 2 weeks.

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
try {
$result = $client->getNumbers()->numbersListReleased();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling numbersListReleased: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return Type

PingramModelListReleasedPhoneNumbersResponse

numbersOrderNumber()

Purchase a phone number for the authenticated account, or reactivate a released number owned by the account (preserves original createdAt). Pass phoneNumber in E.164 format (e.g. +15551234567).

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\OrderPhoneNumberRequest(); // configure as needed
try {
$result = $client->getNumbers()->numbersOrderNumber($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling numbersOrderNumber: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | —————————— | —————————————— | ——————————— | —– | — | | order_phone_number_request | \Pingram\Model\OrderPhoneNumberRequest | See Request Body Properties below | | |

Request Body Properties

Name Type Description
phoneNumber string (required) E.164 from search results

Return Type

PingramModelOrderPhoneNumberResponse

numbersReleaseNumber()

Release a phone number from the account. No refund for the current billing month.

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
try {
$result = $client->getNumbers()->numbersReleaseNumber();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling numbersReleaseNumber: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
phone_number string E.164 phone number to release

Return Type

PingramModelReleasePhoneNumberResponse

numbersSearchAvailable()

Search for available phone numbers to purchase. Requires countryCode (e.g. US, CA). Use before ordering a number.

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
try {
$result = $client->getNumbers()->numbersSearchAvailable();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling numbersSearchAvailable: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
country_code string ISO 3166-1 alpha-2 country code (e.g., US, CA)
features string Comma-separated [optional]
area_code string National destination / area code filter [optional]
limit float Max results (default 10, max 50) [optional]

Return Type

PingramModelSearchAvailablePhoneNumbersResponse

Organization

organizationCreate()

Create organization after SMS verification bypass

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
try {
$result = $client->getOrganization()->organizationCreate();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling organizationCreate: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return Type

PingramModelCreateOrganizationResponse

organizationGetUsage()

Get usage for the authenticated account’s organization (new billing model).

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
try {
$result = $client->getOrganization()->organizationGetUsage();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling organizationGetUsage: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return Type

PingramModelOrganizationUsage

organizationGetUsageHistory()

Get historical usage for the authenticated account’s organization over a date range.

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
try {
$result = $client->getOrganization()->organizationGetUsageHistory();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling organizationGetUsageHistory: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
start_date string Start date (YYYY-MM-DD) for the range
end_date string End date (YYYY-MM-DD) for the range

Return Type

PingramModelOrganizationUsageHistory

Profile

profileAcceptInvite()

Accept a team invitation using a token

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\AcceptInviteRequest(); // configure as needed
try {
$result = $client->getProfile()->profileAcceptInvite($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling profileAcceptInvite: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | ———————–– | ––––––––––––––––––– | ——————————— | —– | — | | accept_invite_request | \Pingram\Model\AcceptInviteRequest | See Request Body Properties below | | |

Request Body Properties

Name Type Description
token string (required)

Return Type

PingramModelAcceptInviteResponse

profileChangeEmail()

Change the email address of the authenticated user

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\ChangeEmailRequest(); // configure as needed
try {
$result = $client->getProfile()->profileChangeEmail($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling profileChangeEmail: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | ———————— | ———————————–– | ——————————— | —– | — | | change_email_request | \Pingram\Model\ChangeEmailRequest | See Request Body Properties below | | |

Request Body Properties

Name Type Description
newEmail string (required)

Return Type

PingramModelSuccessResponse

profileDeleteAccount()

Permanently delete the authenticated user’s account

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\DeleteAccountRequest(); // configure as needed
try {
$result = $client->getProfile()->profileDeleteAccount($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling profileDeleteAccount: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | ––––––––––––– | ————————————— | ——————————— | —– | — | | delete_account_request | \Pingram\Model\DeleteAccountRequest | See Request Body Properties below | | |

Request Body Properties

Name Type Description
reason string

Return Type

PingramModelSuccessResponse

profileDisableMfa()

Disable MFA for the authenticated user

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
try {
$result = $client->getProfile()->profileDisableMfa();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling profileDisableMfa: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
type string MFA type (e.g. SOFTWARE_TOKEN_MFA)

Return Type

PingramModelSuccessResponse

profileGetMfaStatus()

Get MFA status for the authenticated user

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
try {
$result = $client->getProfile()->profileGetMfaStatus();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling profileGetMfaStatus: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return Type

PingramModelMFAStatusResponse

profileSetupMfa()

Start TOTP MFA setup and return QR code data

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\MFASetupRequest(); // configure as needed
try {
$result = $client->getProfile()->profileSetupMfa($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling profileSetupMfa: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | ——————— | ––––––––––––––––– | ——————————— | —– | — | | mfa_setup_request | \Pingram\Model\MFASetupRequest | See Request Body Properties below | | |

Request Body Properties

Name Type Description
type “SOFTWARE_TOKEN_MFA” (required) MFA methods supported by the profile MFA API.

Return Type

PingramModelMFASetupResponse

profileVerifyMfa()

Verify TOTP code and enable MFA

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\MFAVerifyRequest(); // configure as needed
try {
$result = $client->getProfile()->profileVerifyMfa($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling profileVerifyMfa: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | ––––––––––– | ———————————– | ——————————— | —– | — | | mfa_verify_request | \Pingram\Model\MFAVerifyRequest | See Request Body Properties below | | |

Request Body Properties

Name Type Description
type “SOFTWARE_TOKEN_MFA” (required) MFA methods supported by the profile MFA API.
code string (required)
session string (required)

Return Type

PingramModelSuccessResponse

PushSettings

pushSettingsDeletePushApnSettings()

Delete Apple Push Notification (APN) configuration for the current account.

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
try {
$result = $client->getPushSettings()->pushSettingsDeletePushApnSettings();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling pushSettingsDeletePushApnSettings: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return Type

void (empty response body)

pushSettingsDeletePushFcmSettings()

Delete Firebase Cloud Messaging (FCM) configuration for the current account.

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
try {
$result = $client->getPushSettings()->pushSettingsDeletePushFcmSettings();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling pushSettingsDeletePushFcmSettings: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return Type

void (empty response body)

pushSettingsGetPushApnSettings()

Get Apple Push Notification (APN) configuration for the current account.

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
try {
$result = $client->getPushSettings()->pushSettingsGetPushApnSettings();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling pushSettingsGetPushApnSettings: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return Type

PingramModelAPNConfig

pushSettingsGetPushFcmSettings()

Get Firebase Cloud Messaging (FCM) configuration for the current account.

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
try {
$result = $client->getPushSettings()->pushSettingsGetPushFcmSettings();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling pushSettingsGetPushFcmSettings: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return Type

PingramModelPushSettingsFCMResponse

pushSettingsUpsertPushApnSettings()

Create or update Apple Push Notification (APN) configuration for the current account.

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\APNConfig(); // configure as needed
try {
$result = $client->getPushSettings()->pushSettingsUpsertPushApnSettings($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling pushSettingsUpsertPushApnSettings: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | ––––––– | –––––––––––––– | ——————————— | —– | — | | apn_config | \Pingram\Model\APNConfig | See Request Body Properties below | | |

Request Body Properties

Name Type Description
KeyId string (required)
Key string (required)
TeamId string (required)
Topic string (required)

Return Type

PingramModelAPNConfig

pushSettingsUpsertPushFcmSettings()

Create or update Firebase Cloud Messaging (FCM) configuration for the current account.

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\PushSettingsFCMPutRequest(); // configure as needed
try {
$result = $client->getPushSettings()->pushSettingsUpsertPushFcmSettings($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling pushSettingsUpsertPushFcmSettings: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | ——————————— | –––––––––––––––––––––– | ——————————— | —– | — | | push_settings_fcm_put_request | \Pingram\Model\PushSettingsFCMPutRequest | See Request Body Properties below | | |

Request Body Properties

Name Type Description
fcmConfig string (required)

Return Type

PingramModelPushSettingsFCMResponse

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->getSender()->senderDeleteSchedule();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling senderDeleteSchedule: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
tracking_id string The tracking ID of the scheduled notification

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->getSender()->senderTestEmail($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling senderTestEmail: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | ————————— | ————————————— | ——————————— | —– | — | | post_email_test_request | \Pingram\Model\PostEmailTestRequest | See Request Body Properties below | | |

Request Body Properties

Name Type Description
notificationId string (required)
to string (required)
subject string (required)
html string (required)
fromAddress string (required)
fromName string (required)
previewText string

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->getSender()->senderUpdateSchedule($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling senderUpdateSchedule: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | –––––––––– | ——————————— | ——————————————— | —– | — | | tracking_id | string | The tracking ID of the scheduled notification | | | sender_post_body | \Pingram\Model\SenderPostBody | See Request Body Properties below | | |

Request Body Properties

Name Type Description
type string ID of the notification type (e.g. “welcome_email”). Creates a new notification if it does not exist.
to object Recipient user. Provide id, email, or number to identify the user.
to.id string Unique user identifier. Required.
to.email string User’s email address for email notifications.
to.number string User’s phone number for SMS/call notifications.
to.pushTokens object[] Mobile push tokens (FCM, APN) for push notifications.
to.pushTokens[].type “FCM” | “APN” (required)
to.pushTokens[].token string (required)
to.pushTokens[].device object (required)
to.pushTokens[].device.app_id string
to.pushTokens[].device.ad_id string
to.pushTokens[].device.device_id string (required)
to.pushTokens[].device.platform string
to.pushTokens[].device.manufacturer string
to.pushTokens[].device.model string
to.pushTokens[].environment string used by APN to differentiate between sandbox and production builds (sandbox/undefined or production)
to.webPushTokens object[] Web push subscription config from the browser.
to.webPushTokens[].sub object (required) Configuration for a Push Subscription. This can be obtained on the frontend by calling serviceWorkerRegistration.pushManager.subscribe(). The expected format is the same output as JSON.stringify’ing a PushSubscription in the browser.
to.webPushTokens[].sub.endpoint string (required)
to.webPushTokens[].sub.keys object (required)
to.webPushTokens[].sub.keys.p256dh string (required)
to.webPushTokens[].sub.keys.auth string (required)
to.timezone string User’s timezone (e.g. “America/New_York”) for scheduling.
to.slackChannel string The destination channel of slack notifications sent to this user. Can be either of the following: - Channel name, e.g. “test” - Channel name with # prefix, e.g. “#test” - Channel ID, e.g. “C1234567890” - User ID for DM, e.g. “U1234567890” - Username with @ prefix, e.g. “@test”
to.slackToken object
to.slackToken.access_token string
to.slackToken.app_id string
to.slackToken.authed_user object
to.slackToken.authed_user.access_token string
to.slackToken.authed_user.expires_in number
to.slackToken.authed_user.id string
to.slackToken.authed_user.refresh_token string
to.slackToken.authed_user.scope string
to.slackToken.authed_user.token_type string
to.slackToken.bot_user_id string
to.slackToken.enterprise object
to.slackToken.enterprise.id string
to.slackToken.enterprise.name string
to.slackToken.error string
to.slackToken.expires_in number
to.slackToken.incoming_webhook object
to.slackToken.incoming_webhook.channel string
to.slackToken.incoming_webhook.channel_id string
to.slackToken.incoming_webhook.configuration_url string
to.slackToken.incoming_webhook.url string
to.slackToken.is_enterprise_install boolean
to.slackToken.needed string
to.slackToken.ok boolean (required)
to.slackToken.provided string
to.slackToken.refresh_token string
to.slackToken.scope string
to.slackToken.team object
to.slackToken.team.id string
to.slackToken.team.name string
to.slackToken.token_type string
to.slackToken.warning string
to.slackToken.response_metadata object
to.slackToken.response_metadata.warnings string[]
to.slackToken.response_metadata.next_cursor string
to.slackToken.response_metadata.scopes string[]
to.slackToken.response_metadata.acceptedScopes string[]
to.slackToken.response_metadata.retryAfter number
to.slackToken.response_metadata.messages string[]
to.lastSeenTime string Last activity timestamp. Updated automatically. Read-only.
to.updatedAt string Last update timestamp. Read-only.
to.createdAt string Creation timestamp. Read-only.
to.emailSuppressionStatus object Bounce or complaint status if email was suppressed. Read-only.
to.emailSuppressionStatus.reason “Bounce” | “Complaint” (required)
to.emailSuppressionStatus.details object (required)
forceChannels (“EMAIL” | “INAPP_WEB” | “SMS” | “CALL” | “PUSH” | “WEB_PUSH” | “SLACK”)[] Override which channels to send to (e.g. [“EMAIL”, “SMS”]). Bypasses notification channel config.
parameters Record<string, any> Key-value pairs for template merge tags. Replaces placeholders like {{firstName}} in templates.
secondaryId string Optional sub-notification identifier for grouping or tracking.
templateId string Specific template ID to use. If omitted, uses the default template for each channel.
subNotificationId string Sub-notification identifier (e.g. for grouping related notifications).
options object Per-channel overrides for send options (email, APN, FCM).
options.email object Email-specific overrides.
options.email.replyToAddresses string[] Reply-to addresses for the email.
options.email.ccAddresses string[] CC recipients.
options.email.bccAddresses string[] BCC recipients.
options.email.fromAddress string Override sender email address.
options.email.fromName string Override sender display name.
options.email.attachments (object | object)[] File attachments (by URL or inline base64 content). Inline content: ~4 MB raw per file (413 if exceeded). URL url: up to 20 MB per file.
options.email.condition string Conditional expression for when to send (e.g. merge tag logic).
options.apn object Apple Push Notification (APN) overrides.
options.apn.expiry number Seconds until the notification expires.
options.apn.priority number Delivery priority (10 = immediate, 5 = power-saving).
options.apn.collapseId string Group notifications with the same ID (replaces previous).
options.apn.threadId string Thread identifier for grouping notifications.
options.apn.badge number Badge count on app icon.
options.apn.sound string Sound file name.
options.apn.contentAvailable boolean Silent background notification (no alert).
options.fcm object Firebase Cloud Messaging (FCM) overrides.
options.fcm.android object Android-specific FCM options.
options.fcm.android.collapseKey string Collapse key for grouping messages.
options.fcm.android.priority “high” | “normal” Delivery priority.
options.fcm.android.ttl number Time to live in seconds.
options.fcm.android.restrictedPackageName string Restrict delivery to a specific package.
options.push object Cross-platform mobile push options (applied to both APN and FCM).
options.push.customData Record<string, string> Up to 3 custom string key-value pairs for deep linking. Included in both APN and FCM payloads.
schedule string
email object Inline email content (subject, html). Use when not using templates.
email.subject string (required) Email subject line.
email.html string (required) HTML body content.
email.previewText string Preview/snippet text shown in inbox.
email.senderName string Display name of sender.
email.senderEmail string Sender email address.
inapp object Inline in-app content (title, url, image).
inapp.title string (required) Notification title.
inapp.url string URL to open when clicked.
inapp.image string Image URL.
sms object Inline SMS content (message, autoReply, from, mediaUrls).
sms.message string SMS/MMS body text.
sms.mediaUrls string[] Public HTTPS URLs of media to attach (MMS). Carriers fetch these via GET. Total size limits apply per provider.
sms.autoReply object
sms.autoReply.message string (required) Auto-reply message to send when user texts in.
sms.from string Override the sender phone number. Must be a verified number on your account.
call object Inline call content (message).
call.message string (required) Text to speak (TTS).
web_push object Inline web push content (title, message, icon, url).
web_push.title string (required) Notification title.
web_push.message string (required) Body text.
web_push.icon string Icon URL.
web_push.url string URL to open when clicked.
mobile_push object Inline mobile push content (title, message).
mobile_push.title string (required) Notification title.
mobile_push.message string (required) Body text.
slack object Inline Slack content (text, blocks, etc.).
slack.text string (required) Fallback plain text (required when using blocks).
slack.blocks Record<string, any>[] Slack Block Kit blocks.
slack.username string Override bot username.
slack.icon string Icon: emoji (e.g. “:smile:”) or URL. Default: bot’s icon.
slack.thread_ts string Parent message ts to post in a thread.
slack.reply_broadcast boolean When true with thread_ts, broadcasts reply to channel. Default: false.
slack.parse “full” | “none” URL parsing: “full” (clickable links) or “none”. Default: “none”.
slack.link_names boolean Convert channel and username refs to Slack links. Default: false.
slack.mrkdwn boolean Enable Slack markup (bold, italic, code). Default: true.
slack.unfurl_links boolean Unfurl link previews. Default: true.
slack.unfurl_media boolean Unfurl media previews. Default: true.
slack.metadata object Slack message metadata with optional work object entities. Combines standard Slack message metadata fields with an array of entity objects.
slack.metadata.entities object[] An array of work object entities.
slack.metadata.entities[].entity_type string (required) Entity type (e.g., ‘slack#/entities/task’, ‘slack#/entities/file’).
slack.metadata.entities[].entity_payload Record<string, any> (required) Schema for the given entity type.
slack.metadata.entities[].external_ref object (required) Reference used to identify an entity within the developer’s system.
slack.metadata.entities[].external_ref.id string (required)
slack.metadata.entities[].external_ref.type string
slack.metadata.entities[].url string (required) URL used to identify an entity within the developer’s system.
slack.metadata.entities[].app_unfurl_url string The exact URL posted in the source message. Required in metadata passed to chat.unfurl.
slack.metadata.event_type string A human readable alphanumeric string representing your application’s metadata event.
slack.metadata.event_payload Record<string, any> A free-form object containing whatever data your application wishes to attach to messages.

Return Type

PingramModelMessageResponse

Sms

smsSend()

Send an SMS or MMS directly without a template. Requires type and to. Pass message and/or mediaUrls. Optional: from, schedule.

<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Pingram\Client;
$client = new Client('YOUR_API_KEY');
$body = new \Pingram\Model\SendSmsRequest(); // configure as needed
try {
$result = $client->getSms()->smsSend($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling smsSend: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | –––––––––– | ——————————— | ——————————— | —– | — | | send_sms_request | \Pingram\Model\SendSmsRequest | See Request Body Properties below | | |

Request Body Properties

Name Type Description
type string (required) The notification type to send.
to string (required) The phone number of the recipient.
message string The message of the SMS or MMS notification. Optional when mediaUrls is provided.
mediaUrls string[] Public HTTPS URLs of media to attach (MMS).
schedule string The ISO 8601 datetime to schedule the SMS notification.
from string Override the sender phone number. Must be a dedicated number on your Pingram account.

Return Type

PingramModelSendSmsResponse

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->getTemplates()->templatesCreateTemplate($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling templatesCreateTemplate: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | ———————–– | ––––––––––––––––––– | ——————————— | —– | — | | notification_id | string | Notification ID | | | channel | string | Channel type | | | template_post_request | \Pingram\Model\TemplatePostRequest | See Request Body Properties below | | |

Request Body Properties

Name Type Description
templateId string (required) Unique ID for this template within the notification and channel. Required.
html string HTML body of the email.
previewText string Preview text (e.g. for inbox).
internal string Internal editor representation of the email content (e.g. Bee or Redactor JSON). Used for editing and component embedding; the actual email sent to recipients uses the html field.
subject string Email subject line.
senderName string Sender display name.
senderEmail string Sender email address.
title string Notification title (in-app).
redirectURL string URL to open when the user taps the notification.
imageURL string Image URL shown in the in-app notification.
instant object Copy for instant (real-time) delivery.
instant.title string
instant.redirectURL string
instant.imageURL string (required)
batch object Copy for batch delivery.
batch.title string (required)
batch.redirectURL string (required)
batch.imageURL string (required)
text string Message text (SMS or call).
message string Push notification body text. (title is shared with INAPP_WEB above.)
icon string Web push: icon URL. Slack: bot icon (emoji or URL).
url string Web push: URL to open when the notification is clicked.
blocks Record<string, any>[] Slack message blocks (optional).
username string Slack bot username.

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->getTemplates()->templatesDeleteTemplate();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling templatesDeleteTemplate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
notification_id string Notification ID
channel string Channel type
template_id string Template ID

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->getTemplates()->templatesGetTemplate();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling templatesGetTemplate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
notification_id string Notification ID
channel string Channel type
template_id string Template ID

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->getTemplates()->templatesListTemplates();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling templatesListTemplates: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
notification_id string Notification ID
channel string Channel type

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->getTemplates()->templatesSetDefaultTemplate($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling templatesSetDefaultTemplate: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | –––––––––––––––– | –––––––––––––––––––––– | ——————————— | —– | — | | notification_id | string | Notification ID | | | channel | string | Channel type | | | set_default_template_request | \Pingram\Model\SetDefaultTemplateRequest | See Request Body Properties below | | |

Request Body Properties

Name Type Description
templateId string (required)
modes (“instant” | “hourly” | “daily” | “weekly” | “monthly”)[] (required)

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->getTemplates()->templatesUpdateTemplate($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling templatesUpdateTemplate: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | ––––––––––––– | ————————————— | ——————————— | —– | — | | notification_id | string | Notification ID | | | channel | string | Channel type | | | template_id | string | Template ID | | | template_patch_request | \Pingram\Model\TemplatePatchRequest | See Request Body Properties below | | |

Request Body Properties

Name Type Description
html string HTML body of the email.
previewText string Preview text (e.g. for inbox).
internal string Internal editor representation of the email content (e.g. Bee or Redactor JSON). Used for editing and component embedding; the actual email sent to recipients uses the html field.
subject string Email subject line.
senderName string Sender display name.
senderEmail string Sender email address.
title string Notification title (in-app).
redirectURL string URL to open when the user taps the notification.
imageURL string Image URL shown in the in-app notification.
instant object Copy for instant (real-time) delivery.
instant.title string
instant.redirectURL string
instant.imageURL string (required)
batch object Copy for batch delivery.
batch.title string (required)
batch.redirectURL string (required)
batch.imageURL string (required)
text string Message text (SMS or call).
message string Push notification body text. (title is shared with INAPP_WEB above.)
icon string Web push: icon URL. Slack: bot icon (emoji or URL).
url string Web push: URL to open when the notification is clicked.
blocks Record<string, any>[] Slack message blocks (optional).
username string Slack bot username.

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->getTypes()->typesCreateNotificationType($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling typesCreateNotificationType: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | —————————–– | –––––––––––––––––––––– | ——————————— | —– | — | | notification_create_request | \Pingram\Model\NotificationCreateRequest | See Request Body Properties below | | |

Request Body Properties

Name Type Description
notificationId string (required)
title string (required)
channels string[] (required)
options object
options.EMAIL object
options.EMAIL.defaultDeliveryOption “off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” (required)
options.EMAIL.off object
options.EMAIL.off.enabled boolean (required)
options.EMAIL.instant object
options.EMAIL.instant.enabled boolean (required)
options.EMAIL.hourly object
options.EMAIL.hourly.enabled boolean (required)
options.EMAIL.daily object
options.EMAIL.daily.enabled boolean (required)
options.EMAIL.daily.hour string
options.EMAIL.weekly object
options.EMAIL.weekly.enabled boolean (required)
options.EMAIL.weekly.hour string
options.EMAIL.weekly.day string
options.EMAIL.monthly object
options.EMAIL.monthly.enabled boolean (required)
options.EMAIL.monthly.hour string
options.EMAIL.monthly.date “first” | “last”
options.INAPP_WEB object
options.INAPP_WEB.defaultDeliveryOption “off” | “instant” (required)
options.INAPP_WEB.off object
options.INAPP_WEB.off.enabled boolean (required)
options.INAPP_WEB.instant object
options.INAPP_WEB.instant.enabled boolean (required)
options.INAPP_WEB.instant.batching boolean
options.INAPP_WEB.instant.batchingKey string
options.INAPP_WEB.instant.batchingWindow number
options.SMS object
options.SMS.defaultDeliveryOption “off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” (required)
options.SMS.off object
options.SMS.off.enabled boolean (required)
options.SMS.instant object
options.SMS.instant.enabled boolean (required)
options.SMS.hourly object
options.SMS.hourly.enabled boolean (required)
options.SMS.daily object
options.SMS.daily.enabled boolean (required)
options.SMS.daily.hour string
options.SMS.weekly object
options.SMS.weekly.enabled boolean (required)
options.SMS.weekly.hour string
options.SMS.weekly.day string
options.SMS.monthly object
options.SMS.monthly.enabled boolean (required)
options.SMS.monthly.hour string
options.SMS.monthly.date “first” | “last”
options.CALL object
options.CALL.defaultDeliveryOption “off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” (required)
options.CALL.off object
options.CALL.off.enabled boolean (required)
options.CALL.instant object
options.CALL.instant.enabled boolean (required)
options.CALL.hourly object
options.CALL.hourly.enabled boolean (required)
options.CALL.daily object
options.CALL.daily.enabled boolean (required)
options.CALL.daily.hour string
options.CALL.weekly object
options.CALL.weekly.enabled boolean (required)
options.CALL.weekly.hour string
options.CALL.weekly.day string
options.CALL.monthly object
options.CALL.monthly.enabled boolean (required)
options.CALL.monthly.hour string
options.CALL.monthly.date “first” | “last”
options.PUSH object
options.PUSH.defaultDeliveryOption “off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” (required)
options.PUSH.off object
options.PUSH.off.enabled boolean (required)
options.PUSH.instant object
options.PUSH.instant.enabled boolean (required)
options.PUSH.hourly object
options.PUSH.hourly.enabled boolean (required)
options.PUSH.daily object
options.PUSH.daily.enabled boolean (required)
options.PUSH.daily.hour string
options.PUSH.weekly object
options.PUSH.weekly.enabled boolean (required)
options.PUSH.weekly.hour string
options.PUSH.weekly.day string
options.PUSH.monthly object
options.PUSH.monthly.enabled boolean (required)
options.PUSH.monthly.hour string
options.PUSH.monthly.date “first” | “last”
options.WEB_PUSH object
options.WEB_PUSH.defaultDeliveryOption “off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” (required)
options.WEB_PUSH.off object
options.WEB_PUSH.off.enabled boolean (required)
options.WEB_PUSH.instant object
options.WEB_PUSH.instant.enabled boolean (required)
options.WEB_PUSH.hourly object
options.WEB_PUSH.hourly.enabled boolean (required)
options.WEB_PUSH.daily object
options.WEB_PUSH.daily.enabled boolean (required)
options.WEB_PUSH.daily.hour string
options.WEB_PUSH.weekly object
options.WEB_PUSH.weekly.enabled boolean (required)
options.WEB_PUSH.weekly.hour string
options.WEB_PUSH.weekly.day string
options.WEB_PUSH.monthly object
options.WEB_PUSH.monthly.enabled boolean (required)
options.WEB_PUSH.monthly.hour string
options.WEB_PUSH.monthly.date “first” | “last”
options.SLACK object
options.SLACK.defaultDeliveryOption “off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” (required)
options.SLACK.off object
options.SLACK.off.enabled boolean (required)
options.SLACK.instant object
options.SLACK.instant.enabled boolean (required)
options.SLACK.hourly object
options.SLACK.hourly.enabled boolean (required)
options.SLACK.daily object
options.SLACK.daily.enabled boolean (required)
options.SLACK.daily.hour string
options.SLACK.weekly object
options.SLACK.weekly.enabled boolean (required)
options.SLACK.weekly.hour string
options.SLACK.weekly.day string
options.SLACK.monthly object
options.SLACK.monthly.enabled boolean (required)
options.SLACK.monthly.hour string
options.SLACK.monthly.date “first” | “last”

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->getTypes()->typesDeleteNotificationType();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling typesDeleteNotificationType: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
notification_id string The notification ID

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->getTypes()->typesGetNotificationType();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling typesGetNotificationType: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
notification_id string The notification ID

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->getTypes()->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->getTypes()->typesUpdateNotificationType($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling typesUpdateNotificationType: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | —————————— | —————————————–– | ——————————— | —– | — | | notification_id | string | The notification ID | | | notification_patch_request | \Pingram\Model\NotificationPatchRequest | See Request Body Properties below | | |

Request Body Properties

| Name | Type | Description | | —————————————— | –––––––––––––––––––––––––––––––––––––––– | ———– | — | | title | string | | | channels | (“EMAIL” | “INAPP_WEB” | “SMS” | “CALL” | “PUSH” | “WEB_PUSH” | “SLACK”)[] | | | enabled | boolean | | | deduplication | object | | | deduplication.duration | number | (required) | | throttling | object | | | throttling.max | number | (required) | | throttling.period | number | (required) | | throttling.unit | “seconds” | “minutes” | “hours” | “days” | “months” | “years” | (required) | | throttling.forever | boolean | (required) | | throttling.scope | (“userId” | “notificationId”)[] | (required) | | retention | number | null | | | options | object | | | options.EMAIL | object | | | options.EMAIL.defaultDeliveryOption | “off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” | (required) | | options.EMAIL.off | object | | | options.EMAIL.off.enabled | boolean | (required) | | options.EMAIL.instant | object | | | options.EMAIL.instant.enabled | boolean | (required) | | options.EMAIL.hourly | object | | | options.EMAIL.hourly.enabled | boolean | (required) | | options.EMAIL.daily | object | | | options.EMAIL.daily.enabled | boolean | (required) | | options.EMAIL.daily.hour | string | | | options.EMAIL.weekly | object | | | options.EMAIL.weekly.enabled | boolean | (required) | | options.EMAIL.weekly.hour | string | | | options.EMAIL.weekly.day | string | | | options.EMAIL.monthly | object | | | options.EMAIL.monthly.enabled | boolean | (required) | | options.EMAIL.monthly.hour | string | | | options.EMAIL.monthly.date | “first” | “last” | | | options.INAPP_WEB | object | | | options.INAPP_WEB.defaultDeliveryOption | “off” | “instant” | (required) | | options.INAPP_WEB.off | object | | | options.INAPP_WEB.off.enabled | boolean | (required) | | options.INAPP_WEB.instant | object | | | options.INAPP_WEB.instant.enabled | boolean | (required) | | options.INAPP_WEB.instant.batching | boolean | | | options.INAPP_WEB.instant.batchingKey | string | | | options.INAPP_WEB.instant.batchingWindow | number | | | options.SMS | object | | | options.SMS.defaultDeliveryOption | “off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” | (required) | | options.SMS.off | object | | | options.SMS.off.enabled | boolean | (required) | | options.SMS.instant | object | | | options.SMS.instant.enabled | boolean | (required) | | options.SMS.hourly | object | | | options.SMS.hourly.enabled | boolean | (required) | | options.SMS.daily | object | | | options.SMS.daily.enabled | boolean | (required) | | options.SMS.daily.hour | string | | | options.SMS.weekly | object | | | options.SMS.weekly.enabled | boolean | (required) | | options.SMS.weekly.hour | string | | | options.SMS.weekly.day | string | | | options.SMS.monthly | object | | | options.SMS.monthly.enabled | boolean | (required) | | options.SMS.monthly.hour | string | | | options.SMS.monthly.date | “first” | “last” | | | options.CALL | object | | | options.CALL.defaultDeliveryOption | “off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” | (required) | | options.CALL.off | object | | | options.CALL.off.enabled | boolean | (required) | | options.CALL.instant | object | | | options.CALL.instant.enabled | boolean | (required) | | options.CALL.hourly | object | | | options.CALL.hourly.enabled | boolean | (required) | | options.CALL.daily | object | | | options.CALL.daily.enabled | boolean | (required) | | options.CALL.daily.hour | string | | | options.CALL.weekly | object | | | options.CALL.weekly.enabled | boolean | (required) | | options.CALL.weekly.hour | string | | | options.CALL.weekly.day | string | | | options.CALL.monthly | object | | | options.CALL.monthly.enabled | boolean | (required) | | options.CALL.monthly.hour | string | | | options.CALL.monthly.date | “first” | “last” | | | options.PUSH | object | | | options.PUSH.defaultDeliveryOption | “off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” | (required) | | options.PUSH.off | object | | | options.PUSH.off.enabled | boolean | (required) | | options.PUSH.instant | object | | | options.PUSH.instant.enabled | boolean | (required) | | options.PUSH.hourly | object | | | options.PUSH.hourly.enabled | boolean | (required) | | options.PUSH.daily | object | | | options.PUSH.daily.enabled | boolean | (required) | | options.PUSH.daily.hour | string | | | options.PUSH.weekly | object | | | options.PUSH.weekly.enabled | boolean | (required) | | options.PUSH.weekly.hour | string | | | options.PUSH.weekly.day | string | | | options.PUSH.monthly | object | | | options.PUSH.monthly.enabled | boolean | (required) | | options.PUSH.monthly.hour | string | | | options.PUSH.monthly.date | “first” | “last” | | | options.WEB_PUSH | object | | | options.WEB_PUSH.defaultDeliveryOption | “off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” | (required) | | options.WEB_PUSH.off | object | | | options.WEB_PUSH.off.enabled | boolean | (required) | | options.WEB_PUSH.instant | object | | | options.WEB_PUSH.instant.enabled | boolean | (required) | | options.WEB_PUSH.hourly | object | | | options.WEB_PUSH.hourly.enabled | boolean | (required) | | options.WEB_PUSH.daily | object | | | options.WEB_PUSH.daily.enabled | boolean | (required) | | options.WEB_PUSH.daily.hour | string | | | options.WEB_PUSH.weekly | object | | | options.WEB_PUSH.weekly.enabled | boolean | (required) | | options.WEB_PUSH.weekly.hour | string | | | options.WEB_PUSH.weekly.day | string | | | options.WEB_PUSH.monthly | object | | | options.WEB_PUSH.monthly.enabled | boolean | (required) | | options.WEB_PUSH.monthly.hour | string | | | options.WEB_PUSH.monthly.date | “first” | “last” | | | options.SLACK | object | | | options.SLACK.defaultDeliveryOption | “off” | “instant” | “hourly” | “daily” | “weekly” | “monthly” | (required) | | options.SLACK.off | object | | | options.SLACK.off.enabled | boolean | (required) | | options.SLACK.instant | object | | | options.SLACK.instant.enabled | boolean | (required) | | options.SLACK.hourly | object | | | options.SLACK.hourly.enabled | boolean | (required) | | options.SLACK.daily | object | | | options.SLACK.daily.enabled | boolean | (required) | | options.SLACK.daily.hour | string | | | options.SLACK.weekly | object | | | options.SLACK.weekly.enabled | boolean | (required) | | options.SLACK.weekly.hour | string | | | options.SLACK.weekly.day | string | | | options.SLACK.monthly | object | | | options.SLACK.monthly.enabled | boolean | (required) | | options.SLACK.monthly.hour | string | | | options.SLACK.monthly.date | “first” | “last” | |

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->getUser()->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->getUser()->userGetAvailableSlackChannels();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling userGetAvailableSlackChannels: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
user_id string User ID

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->getUser()->userGetInAppNotifications();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling userGetInAppNotifications: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
before string Timestamp or ISO date to fetch notifications before [optional]
count float Number of notifications to return (default 10) [optional]

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->getUser()->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->getUser()->userGetUser();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling userGetUser: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
user_id string User ID

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->getUser()->userIdentify($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling userIdentify: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | ——————— | ––––––––––––––––– | ——————————— | —– | — | | user_id | string | User ID | | | post_user_request | \Pingram\Model\PostUserRequest | See Request Body Properties below | | |

Request Body Properties

Name Type Description
id string Unique user identifier. Required.
email string User’s email address for email notifications.
number string User’s phone number for SMS/call notifications.
pushTokens object[] Mobile push tokens (FCM, APN) for push notifications.
pushTokens[].type “FCM” | “APN” (required)
pushTokens[].token string (required)
pushTokens[].device object (required)
pushTokens[].device.app_id string
pushTokens[].device.ad_id string
pushTokens[].device.device_id string (required)
pushTokens[].device.platform string
pushTokens[].device.manufacturer string
pushTokens[].device.model string
pushTokens[].environment string used by APN to differentiate between sandbox and production builds (sandbox/undefined or production)
webPushTokens object[] Web push subscription config from the browser.
webPushTokens[].sub object (required) Configuration for a Push Subscription. This can be obtained on the frontend by calling serviceWorkerRegistration.pushManager.subscribe(). The expected format is the same output as JSON.stringify’ing a PushSubscription in the browser.
webPushTokens[].sub.endpoint string (required)
webPushTokens[].sub.keys object (required)
webPushTokens[].sub.keys.p256dh string (required)
webPushTokens[].sub.keys.auth string (required)
timezone string User’s timezone (e.g. “America/New_York”) for scheduling.
slackChannel string The destination channel of slack notifications sent to this user. Can be either of the following: - Channel name, e.g. “test” - Channel name with # prefix, e.g. “#test” - Channel ID, e.g. “C1234567890” - User ID for DM, e.g. “U1234567890” - Username with @ prefix, e.g. “@test”
slackToken object
slackToken.access_token string
slackToken.app_id string
slackToken.authed_user object
slackToken.authed_user.access_token string
slackToken.authed_user.expires_in number
slackToken.authed_user.id string
slackToken.authed_user.refresh_token string
slackToken.authed_user.scope string
slackToken.authed_user.token_type string
slackToken.bot_user_id string
slackToken.enterprise object
slackToken.enterprise.id string
slackToken.enterprise.name string
slackToken.error string
slackToken.expires_in number
slackToken.incoming_webhook object
slackToken.incoming_webhook.channel string
slackToken.incoming_webhook.channel_id string
slackToken.incoming_webhook.configuration_url string
slackToken.incoming_webhook.url string
slackToken.is_enterprise_install boolean
slackToken.needed string
slackToken.ok boolean (required)
slackToken.provided string
slackToken.refresh_token string
slackToken.scope string
slackToken.team object
slackToken.team.id string
slackToken.team.name string
slackToken.token_type string
slackToken.warning string
slackToken.response_metadata object
slackToken.response_metadata.warnings string[]
slackToken.response_metadata.next_cursor string
slackToken.response_metadata.scopes string[]
slackToken.response_metadata.acceptedScopes string[]
slackToken.response_metadata.retryAfter number
slackToken.response_metadata.messages string[]

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->getUser()->userMarkInAppNotificationsAsSeen($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling userMarkInAppNotificationsAsSeen: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | –––––––––––––––––––––– | —————————————————— | ——————————— | —– | — | | in_app_notification_unread_clear_request | \Pingram\Model\InAppNotificationUnreadClearRequest | See Request Body Properties below | | |

Request Body Properties

Name Type Description
notificationId string
trackingId string

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->getUser()->userUpdateInAppNotificationStatus($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling userUpdateInAppNotificationStatus: ', $e->getMessage(), PHP_EOL;
}

Parameters

| Name | Type | Description | Notes | | ———————————–– | ———————————————— | ——————————— | —– | — | | in_app_notification_patch_request | \Pingram\Model\InAppNotificationPatchRequest | See Request Body Properties below | | |

Request Body Properties

Name Type Description
trackingIds string[] (required)
opened string
clicked string
archived string
actioned1 string
actioned2 string
reply object
reply.date string (required)
reply.message string (required)
replies object[]
replies[].date string (required)
replies[].message string (required)

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->getUsers()->usersDeleteUser();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling usersDeleteUser: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
user_id string User ID
env_id string Environment ID (required when using JWT auth) [optional]

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->getUsers()->usersListUsers();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling usersListUsers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
limit float Maximum number of users to return (default
next_token string Pagination token for next page
env_id string Environment ID (required when using JWT auth) [optional]

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->getUsers()->usersRemoveUserFromSuppression();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling usersRemoveUserFromSuppression: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
user_id string User ID
channel string Channel type (EMAIL)
env_id string Environment ID (required when using JWT auth) [optional]

Return Type

PingramModelUserSuppressionDeleteResponse