Ruby SDK

Setup & Initialization

1. Install:

gem install pingram

Or add to your Gemfile:

gem 'pingram'

2. Require and initialize:

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

* required

Region specific example:

client = Pingram::Client.new(api_key: 'YOUR_API_KEY', base_url: 'https://api.eu.pingram.io')

Send

call_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.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::SenderPostBody.new # configure as needed

begin
  result = client.send(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling call_send: #{e}"
end

Parameters

Request Body Properties

Return Type

SenderPostResponse

Webhooks

webhooks_create_webhook()

Create a webhook endpoint on a server outside Pingram. Pingram later POSTs signed JSON to that URL when one of the subscribed events happens. This call only saves the endpoint; it does not send a webhook and does not modify the destination server. The response includes id and a signing secret starting with pingram_whsecret_. Save it and verify the X-Pingram-Signature header. Updates keep this secret. At most 10 endpoints per account. The URL must be a public HTTPS URL and should return 2xx.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::WebhookEndpointUpsertRequest.new # configure as needed

begin
  result = client.webhooks.webhooks_create_webhook(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling webhooks_create_webhook: #{e}"
end

Parameters

Request Body Properties

Return Type

WebhookEndpoint

webhooks_delete_webhook()

```ruby
require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.webhooks.webhooks_delete_webhook
  p result
rescue Pingram::ApiError => e
  puts "Error when calling webhooks_delete_webhook: #{e}"
end

Parameters

Return Type

nil (empty response body)

webhooks_list_webhooks()

List webhook endpoints on the current account, including each id, URL, subscribed events, and signing secret. Use the id with update or delete.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.webhooks.webhooks_list_webhooks
  p result
rescue Pingram::ApiError => e
  puts "Error when calling webhooks_list_webhooks: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

WebhookEndpointsResponse

webhooks_update_webhook()

Replace one webhook endpoint’s URL and its full event subscription. The URL is a server outside Pingram. endpointId comes from list or create. The signing secret stays the same. events is the complete set; omitting an event unsubscribes it, and the previous URL stops receiving events. The previous URL and event list are not kept. The URL must be a public HTTPS URL.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::WebhookEndpointUpsertRequest.new # configure as needed

begin
  result = client.webhooks.webhooks_update_webhook(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling webhooks_update_webhook: #{e}"
end

Parameters

Request Body Properties

Return Type

WebhookEndpoint

Accounts

accounts_create_account()

Create one additional Pingram account (a separate workspace) for the signed-in user. The caller must already belong to an account. Requires a user session or personal access token; an account API key cannot call this. Does not create a login, and does not change, delete, or grant access to existing accounts. Omit plan and nothing is charged. The new account is ready for billing to be added later, and it cannot send until then. Setting plan charges immediately. It starts a paid subscription on the payment method already saved on sourceBillingAccountId, an account the caller must own. Optional memberEmails adds people who already share an account with the caller and invites everyone else.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::CreateAccountRequest.new # configure as needed

begin
  result = client.accounts.accounts_create_account(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling accounts_create_account: #{e}"
end

Parameters

Request Body Properties

Return Type

CreateAccountResponse

accounts_list_accounts()

List accounts the authenticated user can access

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.accounts.accounts_list_accounts
  p result
rescue Pingram::ApiError => e
  puts "Error when calling accounts_list_accounts: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

ListAccountsResponse

Addresses

addresses_create_address()

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.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::CreateAddressRequest.new # configure as needed

begin
  result = client.addresses.addresses_create_address(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling addresses_create_address: #{e}"
end

Parameters

Request Body Properties

Return Type

AddressResponse

addresses_delete_address()

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

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.addresses.addresses_delete_address
  p result
rescue Pingram::ApiError => e
  puts "Error when calling addresses_delete_address: #{e}"
end

Parameters

Return Type

SuccessResponse

addresses_list_addresses()

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

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.addresses.addresses_list_addresses
  p result
rescue Pingram::ApiError => e
  puts "Error when calling addresses_list_addresses: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

AccountAddressesResponse

addresses_update_address()

Update one inbox on this account. A new prefix deletes the old address, so mail to the previous address stops, and that address is not kept. displayName only relabels a custom inbox and does not change where mail is delivered. Does not create an inbox or change its domain.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::UpdateAddressRequest.new # configure as needed

begin
  result = client.addresses.addresses_update_address(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling addresses_update_address: #{e}"
end

Parameters

Request Body Properties

Return Type

AddressResponse

Broadcasts

broadcasts_archive()

Archive an email broadcast so it is hidden from the default broadcast list. Allowed for draft, paused, sent, and canceled broadcasts. Not allowed while sending or scheduled.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.broadcasts.broadcasts_archive
  p result
rescue Pingram::ApiError => e
  puts "Error when calling broadcasts_archive: #{e}"
end

Parameters

Return Type

BroadcastResponse

broadcasts_cancel()

Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule (they can be scheduled again). Sending or paused broadcasts become canceled; recipients already processed stay as they are, and remaining pending recipients are skipped and will not be sent. That skip cannot be undone.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.broadcasts.broadcasts_cancel
  p result
rescue Pingram::ApiError => e
  puts "Error when calling broadcasts_cancel: #{e}"
end

Parameters

Return Type

BroadcastResponse

broadcasts_create()

Create a draft email broadcast. html is the send-ready body. Optional internalTemplate is visual-editor source; if set it must be paired with html. A later update can add it to a draft by sending it with html. Set audience to either a Mongo-style user filter (sync users via Users API first; for large lists) or a raw email list (max 10,000). Include name, from fields, subject, and HTML. Notification type is optional on create and required before send or schedule; it is created automatically if missing.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::CreateBroadcastRequest.new # configure as needed

begin
  result = client.broadcasts.broadcasts_create(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling broadcasts_create: #{e}"
end

Parameters

Request Body Properties

Return Type

BroadcastResponse

broadcasts_delete()

Delete an email broadcast. Allowed for drafts, scheduled, paused, completed, and canceled broadcasts. Not allowed while status is sending.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.broadcasts.broadcasts_delete
  p result
rescue Pingram::ApiError => e
  puts "Error when calling broadcasts_delete: #{e}"
end

Parameters

Return Type

MessageResponse

broadcasts_get()

Get one email broadcast by ID, including the send-ready html body, optional internalTemplate (visual-editor source), and audience definition.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.broadcasts.broadcasts_get
  p result
rescue Pingram::ApiError => e
  puts "Error when calling broadcasts_get: #{e}"
end

Parameters

Return Type

BroadcastResponse

broadcasts_get_metrics()

Poll live email broadcast metrics: status, optional pausedReason or scheduleAt, and aggregate counters (total, sent, delivered, opened, clicked, bounced, complained, unsubscribed, skipped, failed).

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.broadcasts.broadcasts_get_metrics
  p result
rescue Pingram::ApiError => e
  puts "Error when calling broadcasts_get_metrics: #{e}"
end

Parameters

Return Type

BroadcastMetricsResponse

broadcasts_list()

List email broadcasts for the account, newest first. Returns metadata without html or internalTemplate bodies. A live-filter audience includes the filter. A raw email audience includes emailCount and omits the addresses. Paginate with limit (default 50, max 100) and nextToken.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.broadcasts.broadcasts_list
  p result
rescue Pingram::ApiError => e
  puts "Error when calling broadcasts_list: #{e}"
end

Parameters

Return Type

ListBroadcastsResponse

broadcasts_list_recipients()

List email broadcast recipients with per-recipient delivery fact timestamps (sentAt, deliveredAt, openedAt, etc.). Derive display status client-side from timestamps. Filter by status (pending, sent, delivered, opened, clicked, bounced, complained, unsubscribed, skipped, failed, problems). Paginate with limit (default 50, max 200) and nextToken.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.broadcasts.broadcasts_list_recipients
  p result
rescue Pingram::ApiError => e
  puts "Error when calling broadcasts_list_recipients: #{e}"
end

Parameters

Return Type

ListBroadcastRecipientsResponse

broadcasts_pause()

Pause an actively sending email broadcast. Status becomes paused with pausedReason PAUSED_BY_USER.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.broadcasts.broadcasts_pause
  p result
rescue Pingram::ApiError => e
  puts "Error when calling broadcasts_pause: #{e}"
end

Parameters

Return Type

BroadcastResponse

broadcasts_resume()

Resume a paused email broadcast. Continues sending remaining recipients. Broadcasts paused for spam content cannot be resumed.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.broadcasts.broadcasts_resume
  p result
rescue Pingram::ApiError => e
  puts "Error when calling broadcasts_resume: #{e}"
end

Parameters

Return Type

BroadcastResponse

broadcasts_schedule()

Schedule a draft email broadcast for a future ISO datetime (sendAt). Requires a non-empty subject. fromAddress must be the platform default sender or a domain verified for this account (Settings → Domain Verification). The platform default sender is for testing only (at most 10 recipients, heavily throttled). Cancels any existing schedule when the broadcast is returned to draft via cancel.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::ScheduleBroadcastRequest.new # configure as needed

begin
  result = client.broadcasts.broadcasts_schedule(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling broadcasts_schedule: #{e}"
end

Parameters

Request Body Properties

Return Type

BroadcastResponse

broadcasts_send()

Send a draft email broadcast immediately. Requires a non-empty subject. fromAddress must be the platform default sender or a domain verified for this account (Settings → Domain Verification). The platform default sender is for testing only (at most 10 recipients, heavily throttled). Transitions status to sending and starts delivery.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.broadcasts.broadcasts_send
  p result
rescue Pingram::ApiError => e
  puts "Error when calling broadcasts_send: #{e}"
end

Parameters

Return Type

BroadcastResponse

broadcasts_unarchive()

Restore an archived email broadcast to the default broadcast list.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.broadcasts.broadcasts_unarchive
  p result
rescue Pingram::ApiError => e
  puts "Error when calling broadcasts_unarchive: #{e}"
end

Parameters

Return Type

BroadcastResponse

broadcasts_update()

Update a draft email broadcast. Fields you send replace the stored values (name, type, audience, sender, subject, html) and the previous values are not kept; omitted fields stay. html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate is visual-editor source: send it with html to add it to an html-only draft or to update it. It cannot be removed. Only drafts can be edited; scheduled or active broadcasts are locked. This does not send the broadcast.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::UpdateBroadcastRequest.new # configure as needed

begin
  result = client.broadcasts.broadcasts_update(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling broadcasts_update: #{e}"
end

Parameters

Request Body Properties

Return Type

BroadcastResponse

Domains

domains_add_domain()

Start verification for a domain you already own so Pingram can use it for email. Pass a bare domain (example.com) or subdomain (mail.example.com). This does not purchase, transfer, renew, or control the domain, does not edit DNS, and does not disable sending or receiving on other platforms. It saves the domain on this Pingram account and returns DNS records for you to publish. Required DKIM lets Pingram send email from addresses on this domain once verification completes. Optional inbound MX, once you publish it, routes that domain’s inbound email to Pingram. This call only begins verification. Publish the records, then start verification in the dashboard or with the start-verification API. Adding a domain that is already on the account returns the existing records.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::PostSendersRequestBody.new # configure as needed

begin
  result = client.domains.domains_add_domain(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling domains_add_domain: #{e}"
end

Parameters

Request Body Properties

Return Type

Array<GetSendersResponseInner>

domains_delete_domain()

Remove a sender domain from the account.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.domains.domains_delete_domain
  p result
rescue Pingram::ApiError => e
  puts "Error when calling domains_delete_domain: #{e}"
end

Parameters

Return Type

SuccessResponse

domains_list_domains()

List domains already added to this Pingram account for email. Each entry includes verification status and the DNS records Pingram expects you to publish. Does not search a registrar, purchase or transfer a domain, change DNS, or include domains that have not been added to this account.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.domains.domains_list_domains
  p result
rescue Pingram::ApiError => e
  puts "Error when calling domains_list_domains: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

Array<GetSendersResponseInner>

domains_start_domain_verification()

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

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.domains.domains_start_domain_verification
  p result
rescue Pingram::ApiError => e
  puts "Error when calling domains_start_domain_verification: #{e}"
end

Parameters

Return Type

Array<GetSendersResponseInner>

Email

email_delete_suppressions()

Start removing all email suppressions of the given reason (retryable or bounces) for users in the environment. Returns immediately after the job is queued — suppressions are not yet cleared when this response is received. Large removals are processed in the background in batches.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.email.email_delete_suppressions
  p result
rescue Pingram::ApiError => e
  puts "Error when calling email_delete_suppressions: #{e}"
end

Parameters

Return Type

MessageResponse

email_send()

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.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::SendEmailRequest.new # configure as needed

begin
  result = client.email.email_send(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling email_send: #{e}"
end

Parameters

Request Body Properties

Return Type

SendEmailApiResponse

Environments

environments_list_environments()

Get all environments for the authenticated account

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.environments.environments_list_environments
  p result
rescue Pingram::ApiError => e
  puts "Error when calling environments_list_environments: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

Array<GetEnvironmentsResponseInner>

environments_update_environment()

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

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::EnvironmentPatchRequest.new # configure as needed

begin
  result = client.environments.environments_update_environment(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling environments_update_environment: #{e}"
end

Parameters

Request Body Properties

Return Type

Environment

Library

library_create()

Create an upload slot in the account library. contentType must be image/png, image/jpeg, image/gif, or image/webp. PUT the file to the returned uploadUrl with that Content-Type, then use the returned url in emails and the editor.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::CreateLibraryRequest.new # configure as needed

begin
  result = client.library.library_create(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling library_create: #{e}"
end

Parameters

Request Body Properties

Return Type

CreateLibraryResponse

library_list()

List files in the account library for a use-case, newest first. Paginate with limit (default 50, max 100) and nextToken.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.library.library_list
  p result
rescue Pingram::ApiError => e
  puts "Error when calling library_list: #{e}"
end

Parameters

Return Type

ListLibraryResponse

Logs

logs_get_delivery_status()

Look up email and SMS delivery status for up to 25 tracking IDs. Each entry is the tracking id, channel (EMAIL or SMS), status, and the time that status was recorded. The result does not include recipients, phone numbers, user ids, request bodies, IP addresses, account ids, or user-agent data. Unknown tracking ids are omitted. Other channels are not included.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.logs.logs_get_delivery_status
  p result
rescue Pingram::ApiError => e
  puts "Error when calling logs_get_delivery_status: #{e}"
end

Parameters

Return Type

LogsDeliveryStatusResponse

logs_get_log_retention()

Get log retention period in days for the account

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.logs.logs_get_log_retention
  p result
rescue Pingram::ApiError => e
  puts "Error when calling logs_get_log_retention: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

LogsRetentionResponse

logs_get_logs()

List recent notification logs for the authenticated account, newest first.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.logs.logs_get_logs
  p result
rescue Pingram::ApiError => e
  puts "Error when calling logs_get_logs: #{e}"
end

Parameters

Return Type

GetLogsResponse

logs_get_logs_by_tracking_ids()

Get logs by tracking IDs (comma-separated, max 25 IDs). Returns full log objects with personally identifiable information (recipients, user ids, phone numbers, and request details). For a simple delivery check, use Get Delivery Status.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.logs.logs_get_logs_by_tracking_ids
  p result
rescue Pingram::ApiError => e
  puts "Error when calling logs_get_logs_by_tracking_ids: #{e}"
end

Parameters

Return Type

LogsGetResponse

logs_get_logs_query_result()

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

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.logs.logs_get_logs_query_result
  p result
rescue Pingram::ApiError => e
  puts "Error when calling logs_get_logs_query_result: #{e}"
end

Parameters

Return Type

LogsQueryResultResponse

logs_retry_inbound()

Resend the EMAIL_INBOUND webhook for one inbound email. Uses the original tracking ID and does not count another email. Refused when the message is older than 30 days.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.logs.logs_retry_inbound
  p result
rescue Pingram::ApiError => e
  puts "Error when calling logs_retry_inbound: #{e}"
end

Parameters

Return Type

MessageResponse

logs_start_logs_query()

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

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::LogQueryPostBody.new # configure as needed

begin
  result = client.logs.logs_start_logs_query(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling logs_start_logs_query: #{e}"
end

Parameters

Request Body Properties

Return Type

LogsQueryResponse

logs_tail_logs()

Get last 100 logs from the stream

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.logs.logs_tail_logs
  p result
rescue Pingram::ApiError => e
  puts "Error when calling logs_tail_logs: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

LogsTailResponse

Numbers

numbers_list()

List active phone numbers registered for the account, including voice agent binding state.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.numbers.numbers_list
  p result
rescue Pingram::ApiError => e
  puts "Error when calling numbers_list: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

ListPhoneNumbersResponse

numbers_list_released()

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.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.numbers.numbers_list_released
  p result
rescue Pingram::ApiError => e
  puts "Error when calling numbers_list_released: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

ListReleasedPhoneNumbersResponse

numbers_order_number()

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).

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::OrderPhoneNumberRequest.new # configure as needed

begin
  result = client.numbers.numbers_order_number(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling numbers_order_number: #{e}"
end

Parameters

Request Body Properties

Return Type

OrderPhoneNumberResponse

numbers_release_number()

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

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.numbers.numbers_release_number
  p result
rescue Pingram::ApiError => e
  puts "Error when calling numbers_release_number: #{e}"
end

Parameters

Return Type

ReleasePhoneNumberResponse

numbers_search_available()

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

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.numbers.numbers_search_available
  p result
rescue Pingram::ApiError => e
  puts "Error when calling numbers_search_available: #{e}"
end

Parameters

Return Type

SearchAvailablePhoneNumbersResponse

Profile

profile_accept_invite()

Accept a team invitation using a token

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::AcceptInviteRequest.new # configure as needed

begin
  result = client.profile.profile_accept_invite(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling profile_accept_invite: #{e}"
end

Parameters

Request Body Properties

Return Type

AcceptInviteResponse

profile_delete_account()

Permanently delete the authenticated user’s account

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::DeleteAccountRequest.new # configure as needed

begin
  result = client.profile.profile_delete_account(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling profile_delete_account: #{e}"
end

Parameters

Request Body Properties

Return Type

SuccessResponse

profile_disable_mfa()

Disable MFA for the authenticated user

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.profile.profile_disable_mfa
  p result
rescue Pingram::ApiError => e
  puts "Error when calling profile_disable_mfa: #{e}"
end

Parameters

Return Type

SuccessResponse

profile_get_mfa_status()

Get MFA status for the authenticated user

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.profile.profile_get_mfa_status
  p result
rescue Pingram::ApiError => e
  puts "Error when calling profile_get_mfa_status: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

MFAStatusResponse

profile_setup_mfa()

Start TOTP MFA setup and return QR code data

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::MFASetupRequest.new # configure as needed

begin
  result = client.profile.profile_setup_mfa(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling profile_setup_mfa: #{e}"
end

Parameters

Request Body Properties

Return Type

MFASetupResponse

profile_verify_mfa()

Verify TOTP code and enable MFA

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::MFAVerifyRequest.new # configure as needed

begin
  result = client.profile.profile_verify_mfa(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling profile_verify_mfa: #{e}"
end

Parameters

Request Body Properties

Return Type

SuccessResponse

Registrations

registrations_create_us10dlc_brand()

Create a new 10DLC brand registration. Sets brandStatus to pending_review; Pingram handles carrier submission after review.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::TenDlcBrandCreateRequest.new # configure as needed

begin
  result = client.registrations.registrations_create_us10dlc_brand(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling registrations_create_us10dlc_brand: #{e}"
end

Parameters

Request Body Properties

Return Type

TenDlcBrandRegistration

registrations_get_us10dlc_brand()

Get the 10DLC brand registration for the authenticated account. Returns null when no registration exists yet.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.registrations.registrations_get_us10dlc_brand
  p result
rescue Pingram::ApiError => e
  puts "Error when calling registrations_get_us10dlc_brand: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

TenDlcBrandRegistration

registrations_get_us10dlc_campaign()

Get the 10DLC campaign registration for the authenticated account. Returns null when no brand registration exists yet.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.registrations.registrations_get_us10dlc_campaign
  p result
rescue Pingram::ApiError => e
  puts "Error when calling registrations_get_us10dlc_campaign: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

TenDlcCampaignRegistration

registrations_update_us10dlc_brand()

Overwrite business fields on this account’s existing US 10DLC brand registration (legal name, address, tax ID, website, compliance contact, and related identity). Fields you omit stay; values you send replace what was stored and are not kept as history. Does not create a registration, submit it to carriers, change brandStatus, or delete it. Workflow status stays under Pingram’s control.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::TenDlcBrandUpdateRequest.new # configure as needed

begin
  result = client.registrations.registrations_update_us10dlc_brand(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling registrations_update_us10dlc_brand: #{e}"
end

Parameters

Request Body Properties

Return Type

TenDlcBrandRegistration

registrations_update_us10dlc_campaign()

Overwrite campaign fields on this account’s existing US 10DLC campaign (description, samples, opt-in and opt-out text, use case, and related settings). Fields you send replace the stored values and the previous text is not kept; omitted fields stay. Editing is refused once the campaign is in_progress or approved. Does not submit the campaign to carriers, change campaignStatus, or delete it.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::TenDlcCampaignUpdateRequest.new # configure as needed

begin
  result = client.registrations.registrations_update_us10dlc_campaign(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling registrations_update_us10dlc_campaign: #{e}"
end

Parameters

Request Body Properties

Return Type

TenDlcCampaignRegistration

Sender

sender_delete_schedule()

Delete (unschedule) an already scheduled notification

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.sender.sender_delete_schedule
  p result
rescue Pingram::ApiError => e
  puts "Error when calling sender_delete_schedule: #{e}"
end

Parameters

Return Type

MessageResponse

sender_update_schedule()

Update the body or schedule of an already scheduled notification.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::SenderPostBody.new # configure as needed

begin
  result = client.sender.sender_update_schedule(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling sender_update_schedule: #{e}"
end

Parameters

Request Body Properties