How to connect Photon with ChatGPT

Assign or replace SMS line campaign Attach a ready campaign from this project’s organization to its line.

Assign Voice line profile Assigns or replaces a line's explicit additional-profile override when the resource version matches.

Batch update Voice line assignments Atomically sets additional-profile overrides or switches lines back to the project default for up to 100 Voice-capable lines.

Begin TOTP enrollment Requires a first-party interactive Account credential authenticated no more than 300 seconds ago.

Cancel operation Withdraws a provision that has not been fulfilled yet.

Check project slug availability Reports whether createProject would accept `slug` right now.

Commit profile picture Commits a profile picture previously uploaded through createAccountProfilePictureUpload.

Commit agent avatar Commits an agent avatar previously uploaded through createAgentProfileAvatarUpload.

Connect email domain Reserves a normalized DNS domain and starts its durable email-provider setup.

Connect Telegram bot Starts a free managed Telegram bot connection.

Count filtered verification codes Counts the verification codes Photon kept from this project's dedicated lines and numbers, optionally for one `platform`.

Count Messages Counts matching Messages before pagination.

Count projects Counts the projects the same filter would list.

Count a line's filtered verification codes Counts the verification codes Photon kept from one dedicated line or number.

Count Spaces Counts distinct Spaces matching the list filters; multiple matching Messages count once.

Count Users Counts distinct Users matching the list filters, including incoming senders or outgoing recipients selected by Message filters.

Create profile picture upload Creates a ten-minute, Account-bound presigned S3 POST for a JPEG, PNG, or WebP profile picture up to 5 MiB.

Create agent avatar upload Creates a ten-minute, Project-bound presigned S3 POST for a JPEG, PNG, or WebP agent avatar up to 5 MiB.

Create default Voice profile Creates the project default Voice profile when absent.

Create or get a Space Creates or returns a project Space.

Create or get a User Creates or reconciles a User by normalized handle.

Create project Creates in the authorized organization.

Create shared line assignment Maps an end user's iMessage handle — an E.

Create Voice profile Creates a direction-neutral additional Voice profile.

Create WhatsApp shared line assignment Maps an end user's phone number onto one of the project's pooled shared WhatsApp lines, consuming a seat from the project's WhatsApp entitlement.

Create WhatsApp VoIP sender Registers an active, SMS-capable Photon VoIP line on this project's connected WhatsApp Business Account.

Delete account Deletes the authenticated account and returns its account tombstone.

Delete project Starts deletion of the identified project using a credential authorized for project management.

Delete a TOTP factor Requires a first-party interactive Account credential authenticated no more than 300 seconds ago.

Delete Voice profile Deletes an additional profile when expectedVersion matches.

Delete Voice inbound configuration Removes a profile's inbound destination when the shared profile version matches.

Revoke Voice outbound credential Revokes outbound calling for a profile when the shared profile version matches.

Delete webhook destination Deletes the selected project's destination and returns its stable tombstone.

Disconnect WhatsApp Business account Disconnects every attached WhatsApp sender, then unsubscribes our app and removes the project's business account connection.

Get account Returns the profile of the authenticated account.

Get agent profile Returns the agent profile belonging to the identified project.

Get attachment Returns an Attachment's metadata.

Get billing operation Returns the authoritative state of a billing operation belonging to the selected project.

Get project billing overview Returns the selected project's plan information, entitlements and current billing-period usage.

Read the credential's organization Reads the organization the credential is bound to: the organization an OAuth grant was consented for, or a Service Identity's own organization.

Get default Voice profile Gets the profile currently selected as the project default, including its optional inbound delivery state.

Get the project's effective billing terms Returns what the selected project is billed on now, per category it holds: the plan as its subscription has it, with any override applied, each fixed charge at the subscription's price and quantity, and resolved entitlements; where the plan comes from; how invoices are paid; the current period and next billing date; and any downgrade or cancellation waiting for the period end.

Get email delivery metrics Reads cached supplementary email series for the exact Project and rolling day or week.

Get email sending policies Reads Organization email recipient allowances shared across all its Projects, with rolling 60-second and 24-hour windows.

Get a Message Returns one stored Message by canonical Photon Message ID on any supported contract platform.

Get metrics backfill status Returns historical metrics update progress.

Get metrics SQL schema Returns the message_events and call_events SQL schema, supported queries, and limits for the selected API version.

Get MFA status Requires a first-party interactive Account credential.

Get operation Reads one operation using the same operation representation as creation and list.

Get organization billing overview Returns the selected organization’s billing subscription and entitlementsVersion.

Get organization credit Returns the credit the selected organization holds: on credit notes, such as the unused time of a plan an upgrade replaced or the unused days of a prorated fixed charge it released, and in its wallet: the credit Photon granted it, such as a new account's first organization's welcome credit, and any prepaid credit it bought.

Get organization payment method Reports whether the selected organization has a card on file and returns its documented payment-method metadata.

Get the organization's effective billing terms Returns what the selected organization is billed on now on its own subscription, such as SSO and 10DLC campaigns: the plan as the subscription has it, with any override applied, each fixed charge at the subscription's price and the quantity the organization holds, and resolved entitlements; where the plan comes from; how invoices are paid; the current period and next billing date; and any downgrade or cancellation waiting for the period end.

Get project Returns the identified project's settings for an authorized caller.

Get project closure status Returns closure progress for projectId within organizationId, including deletionOperationId, domain progress and ready.

Get project iMessage platform Reports whether the project is on shared or dedicated iMessage lines, derived from its billing entitlements.

Get project WhatsApp platform Reports whether the project is on shared or dedicated WhatsApp lines, derived from its billing entitlements.

Get resource Reads one resource the project holds.

Get shared line assignment Reads one shared line assignment.

Get SMS line campaign assignment Read the last confirmed campaign and current eligibility.

Get a Space Returns one stored Space by canonical Photon Space ID.

Get an User Returns one User after refreshing its Human or Agent classification and project ownership where supported.

Get Voice line profile assignment Gets the explicit additional-profile override for an owned Voice-capable line.

Get Voice profile Gets one reusable Voice profile, including its optional inbound delivery state.

Get webhook destination Returns the configuration of one webhook destination belonging to the selected project.

Get webhook event schema Returns the published reader JSON Schema for eventType in the requested webhook apiVersion.

Get WhatsApp Business account Gets the one WhatsApp Business Account this project has connected, with its number of live senders.

Get WhatsApp shared line assignment Reads one WhatsApp shared line assignment.

Leave an organization; Owners must transfer or close first

List Account Service Keys Returns metadata for the authenticated account's unrevoked service keys, including expired keys, ordered newest first.

List attachments Lists the Project's Attachment metadata, with optional time filters.

List connected applications Lists the OAuth applications authorized by the authenticated user.

List billing plans Lists the billing plan catalog, grouped by their public plan-metadata type.

List credit activity Returns one page of how the selected organization's credit balance changed, newest first: credit notes issued and credit granted, credit applied to invoices, credit restored when the change an invoice paid for never applied, and credit voided.

List email recommendations Reads Photon guidance from stored sending policies, sending setup and domain checks.

List filtered verification codes Lists the verification codes Photon kept from this project's dedicated lines and numbers.

List invoices Returns one page of the selected organization's invoices, newest first: every invoice issued to it with a nonzero total or actual charges, including charges fully paid by credit; drafts and empty invoices are excluded.

List Messages Lists the Project's Messages, with optional resource, conversation, and time filters.

List number area codes Lists current provider coverage for US local numbers, sorted and deduplicated.

List number countries Lists supported purchase countries independently of current provider inventory.

List OAuth scopes Lists the business permissions available to OAuth applications.

List operations Lists the project's operations using the same operation representation as creation and GET.

List current organization members

List project platforms Lists the platform types available to this project.

List projects Returns a cursor-paginated page of the active projects in organizationId.

List project subscriptions Lists the plan each of the selected project's categories holds, with its price and the payer's standing.

List a line's filtered verification codes Lists the verification codes Photon kept from one dedicated line or number.

List resources Lists the project's resources, oldest first, including retired ones unless `state` filters them out.

List shared line assignments Lists the project's shared line assignments, oldest first.

List Spaces Lists the Project's stored Spaces, with optional participant and Message filters.

List Users Lists stored Users without refreshing their classification; use Get User for current details.

List Voice profiles Lists reusable Voice profiles in this project.

List webhook API versions Lists the published webhook payload API versions and their lifecycle metadata.

List webhook destinations Returns a cursor-paginated page of active webhook destinations configured for the selected project.

List webhook egress addresses Returns the public network addresses from which this environment sends webhook deliveries.

List webhook event types Lists the webhook event types available in the requested apiVersion, including their descriptions, audiences and reader-schema URLs.

List WhatsApp account phone numbers Lists the connected WABA's phone numbers directly from Meta, including numbers whose Photon sender was disconnected.

List WhatsApp shared line assignments Lists the project's WhatsApp shared line assignments, oldest first.

Mark a Message as read Persists a request to mark one incoming Message as read using its receiving account.

Preview an organization billing change Previews a fixed-charge quantity change on the selected organization's own subscription, such as SSO.

Preview a project billing change Previews a change on the selected project's subscription in the supplied category: a fixed-charge quantity change, or a plan change with the held fixed charges it carries over.

Provision dedicated iMessage line Claims one dedicated iMessage line for the project and enables iMessage on it.

Provision dedicated WhatsApp line Provisions one dedicated WhatsApp line with WhatsApp and shared Voice enabled.

Purchase SMS number Buys one US local number from the provider and records it as a resource with SMS enabled.

Query metrics Runs read-only SQL over the Project's message_events or call_events table.

Release dedicated iMessage line Removes only iMessage from one dedicated line.

Release resource Gives one resource back, whatever it is.

Release shared line assignment Releases a shared line assignment, freeing both its seat and its handle for reassignment.

Release dedicated WhatsApp line Removes only WhatsApp from one dedicated line.

Release WhatsApp shared line assignment Releases a WhatsApp shared line assignment, freeing its seat for reassignment.

Remove profile picture Removes the authenticated account's custom profile picture and returns the account using its default picture.

Reset agent avatar Replaces the selected project's agent avatar with the project's default avatar, a generated planet image derived from the project ID, and returns the updated agent profile.

Revoke Account Service Key Revokes the account-owned service key identified by serviceKeyId and returns its revoked metadata.

Revoke connected application Revokes the authenticated user's grant for one OAuth application.

Send a Message Sends SMS, email, WhatsApp Personal, WhatsApp Business, iMessage, or Telegram text and image messages.

Set typing in a Space Saves one transient typing update as an authorized Agent in this Space.

Unassign SMS line campaign Any project writer, including a scoped API key, may detach the campaign.

Unassign Voice line profile Removes a line's explicit override when the resource version matches so the line follows the project default.

Update account Updates the supplied firstName and lastName fields on the authenticated account and returns the updated profile.

Update agent profile Updates the supplied firstName and lastName fields in the project's agent profile and returns the updated profile.

Update default Voice profile Patches the default profile's protocol or mediaEncryption when expectedVersion matches.

Update project Updates the identified project's name and returns the updated project.

Update Voice profile Patches an additional profile's name, protocol, or mediaEncryption when expectedVersion matches.

Update Voice outbound authentication Changes a SIP profile's outbound Digest algorithm when expectedVersion matches.

Update webhook destination Updates the supplied URL, name, description, status or enabledEvents fields on a project's webhook destination and returns its updated configuration.

Verify TOTP enrollment Requires a first-party interactive Account credential authenticated no more than 300 seconds ago.