Photon MCP
Manage Photon messaging projects, resources, conversations, voice profiles and webhooks through its official hosted MCP server.
126 actionsAPI key
What your bot can do in Photon MCP
Looks up
- CheckprojectslugavailabilityCheck project slug availability Reports whether createProject would accept slug right now.
- CountfilteredverificationcodesCount filtered verification codes Counts the verification codes Photon kept from this project's dedicated lines and numbers, optionally…
- CountmessagesCount Messages Counts matching Messages before pagination.
- CountprojectsCount projects Counts the projects the same filter would list.
- CountresourcefilteredverificationcodesCount a line's filtered verification codes Counts the verification codes Photon kept from one dedicated line or number.
- CountspacesCount Spaces Counts distinct Spaces matching the list filters.
- CountusersCount Users Counts distinct Users matching the list filters, including incoming senders or outgoing recipients selected by Message filters.
- GetaccountGet account Returns the profile of the authenticated account.
- GetagentprofileGet agent profile Returns the agent profile belonging to the identified project.
- GetattachmentGet attachment Returns an Attachment's metadata.
Show 61 more
- GetbillingoperationGet billing operation Returns the authoritative state of a billing operation belonging to the selected project.
- GetbillingoverviewGet project billing overview Returns the selected project's plan information, entitlements and current billing-period usage.
- GetcurrentorganizationRead the credential's organization Reads the organization the credential is bound to.
- GetdefaultvoiceprofileGet default Voice profile Gets the profile currently selected as the project default, including its optional inbound delivery state.
- GeteffectivetermsGet the project's effective billing terms Returns what the selected project is billed on now, per category it holds.
- GetemaildeliverymetricsGet email delivery metrics Reads cached supplementary email series for the exact Project and rolling day or week.
- GetemailsendingpoliciesGet email sending policies Reads Organization email recipient allowances shared across all its Projects, with rolling 60-second and…
- GetmessageGet a Message Returns one stored Message by canonical Photon Message ID on any supported contract platform.
- GetmessagemetricsbackfillGet metrics backfill status Returns historical metrics update progress.
- GetmessagemetricssqlschemaGet metrics SQL schema Returns the message_events and call_events SQL schema, supported queries, and limits for the selected API version.
- GetmfastatusGet MFA status Requires a first-party interactive Account credential.
- GetoperationGet operation Reads one operation using the same operation representation as creation and list.
- GetorganizationbillingoverviewGet organization billing overview Returns the selected organization’s billing subscription and entitlementsVersion.
- GetorganizationcreditGet organization credit Returns the credit the selected organization holds.
- GetorganizationpaymentmethodGet organization payment method Reports whether the selected organization has a card on file and returns its documented payment-method…
- GetorganizationtermsGet the organization's effective billing terms Returns what the selected organization is billed on now on its own subscription, such as…
- GetprojectGet project Returns the identified project's settings for an authorized caller.
- GetprojectclosurestatusGet project closure status Returns closure progress for projectId within organizationId, including deletionOperationId, domain progress…
- GetprojectimessageplatformGet project iMessage platform Reports whether the project is on shared or dedicated iMessage lines, derived from its billing entitlements.
- GetprojectwhatsappplatformGet project WhatsApp platform Reports whether the project is on shared or dedicated WhatsApp lines, derived from its billing entitlements.
- GetresourceGet resource Reads one resource the project holds.
- GetsharedlineassignmentGet shared line assignment Reads one shared line assignment.
- GetsmslinecampaignassignmentGet SMS line campaign assignment Read the last confirmed campaign and current eligibility.
- GetspaceGet a Space Returns one stored Space by canonical Photon Space ID.
- GetvoicelineprofileassignmentGet Voice line profile assignment Gets the explicit additional-profile override for an owned Voice-capable line.
- GetvoiceprofileGet Voice profile Gets one reusable Voice profile, including its optional inbound delivery state.
- GetwebhookdestinationGet webhook destination Returns the configuration of one webhook destination belonging to the selected project.
- GetwebhookeventschemaGet webhook event schema Returns the published reader JSON Schema for eventType in the requested webhook apiVersion.
- GetwhatsappbusinessaccountGet WhatsApp Business account Gets the one WhatsApp Business Account this project has connected, with its number of live senders.
- GetwhatsappsharedlineassignmentGet WhatsApp shared line assignment Reads one WhatsApp shared line assignment.
- ListaccountservicekeysList Account Service Keys Returns metadata for the authenticated account's unrevoked service keys, including expired keys, ordered newest…
- ListattachmentsList attachments Lists the Project's Attachment metadata, with optional time filters.
- ListauthorizedapplicationsList connected applications Lists the OAuth applications authorized by the authenticated user.
- ListbillingplansList billing plans Lists the billing plan catalog, grouped by their public plan-metadata type.
- ListcreditactivityList credit activity Returns one page of how the selected organization's credit balance changed, newest first.
- ListemailrecommendationsList email recommendations Reads Photon guidance from stored sending policies, sending setup and domain checks.
- ListfilteredverificationcodesList filtered verification codes Lists the verification codes Photon kept from this project's dedicated lines and numbers.
- ListinvoicesList invoices Returns one page of the selected organization's invoices, newest first.
- ListmessagesList Messages Lists the Project's Messages, with optional resource, conversation, and time filters.
- ListnumberareacodesList number area codes Lists current provider coverage for US local numbers, sorted and deduplicated.
- ListnumbercountriesList number countries Lists supported purchase countries independently of current provider inventory.
- ListoauthscopesList OAuth scopes Lists the business permissions available to OAuth applications.
- ListoperationsList operations Lists the project's operations using the same operation representation as creation and GET.
- ListorganizationmembersList current organization members
- ListprojectplatformsList project platforms Lists the platform types available to this project.
- ListprojectsList projects Returns a cursor-paginated page of the active projects in organizationId.
- ListprojectsubscriptionsList project subscriptions Lists the plan each of the selected project's categories holds, with its price and the payer's standing.
- ListresourcefilteredverificationcodesList a line's filtered verification codes Lists the verification codes Photon kept from one dedicated line or number.
- ListresourcesList resources Lists the project's resources, oldest first, including retired ones unless state filters them out.
- ListsharedlineassignmentsList shared line assignments Lists the project's shared line assignments, oldest first.
- ListspacesList Spaces Lists the Project's stored Spaces, with optional participant and Message filters.
- ListusersList Users Lists stored Users without refreshing their classification.
- ListvoiceprofilesList Voice profiles Lists reusable Voice profiles in this project.
- ListwebhookapiversionsList webhook API versions Lists the published webhook payload API versions and their lifecycle metadata.
- ListwebhookdestinationsList webhook destinations Returns a cursor-paginated page of active webhook destinations configured for the selected project.
- ListwebhookegressaddressesList webhook egress addresses Returns the public network addresses from which this environment sends webhook deliveries.
- ListwebhookeventtypesList webhook event types Lists the webhook event types available in the requested apiVersion, including their descriptions, audiences and…
- ListwhatsappaccountphonenumbersList WhatsApp account phone numbers Lists the connected WABA's phone numbers directly from Meta, including numbers whose Photon sender was…
- ListwhatsappsharedlineassignmentsList WhatsApp shared line assignments Lists the project's WhatsApp shared line assignments, oldest first.
- PrevieworganizationchangePreview an organization billing change Previews a fixed-charge quantity change on the selected organization's own subscription, such as SSO.
- PreviewprojectchangePreview a project billing change Previews a change on the selected project's subscription in the supplied category.
Takes action
- AssignsmslinecampaignAssign or replace SMS line campaign Attach a ready campaign from this project’s organization to its line.
- AssignvoicelineprofileAssign Voice line profile Assigns or replaces a line's explicit additional-profile override when the resource version matches.
- BatchupdatevoicelineprofileassignmentsBatch update Voice line assignments Atomically sets additional-profile overrides or switches lines back to the project default for up to…
- BegintotpenrollmentBegin TOTP enrollment Requires a first-party interactive Account credential authenticated no more than 300 seconds ago.
- CanceloperationCancel operation Withdraws a provision that has not been fulfilled yet.
- CommitaccountprofilepictureCommit profile picture Commits a profile picture previously uploaded through createAccountProfilePictureUpload.
- CommitagentprofileavatarCommit agent avatar Commits an agent avatar previously uploaded through createAgentProfileAvatarUpload.
- ConnectemaildomainConnect email domain Reserves a normalized DNS domain and starts its durable email-provider setup.
- ConnecttelegrambotConnect Telegram bot Starts a free managed Telegram bot connection.
- CreateaccountprofilepictureuploadCreate profile picture upload Creates a ten-minute, Account-bound presigned S3 POST for a JPEG, PNG, or WebP profile picture up to 5 MiB.
Show 45 more
- CreateagentprofileavataruploadCreate agent avatar upload Creates a ten-minute, Project-bound presigned S3 POST for a JPEG, PNG, or WebP agent avatar up to 5 MiB.
- CreatedefaultvoiceprofileCreate default Voice profile Creates the project default Voice profile when absent.
- CreateorgetspaceCreate or get a Space Creates or returns a project Space.
- CreateorgetuserCreate or get a User Creates or reconciles a User by normalized handle.
- CreateprojectCreate project Creates in the authorized organization.
- CreatesharedlineassignmentCreate shared line assignment Maps an end user's iMessage handle — an E.164 phone number or an email address — onto one of the project's…
- CreatevoiceprofileCreate Voice profile Creates a direction-neutral additional Voice profile.
- CreatewhatsappsharedlineassignmentCreate WhatsApp shared line assignment Maps an end user's phone number onto one of the project's pooled shared WhatsApp lines, consuming a…
- CreatewhatsappvoipsenderCreate WhatsApp VoIP sender Registers an active, SMS-capable Photon VoIP line on this project's connected WhatsApp Business Account.
- DeleteaccountDelete account Deletes the authenticated account and returns its account tombstone.
- DeleteprojectDelete project Starts deletion of the identified project using a credential authorized for project management.
- DeletetotpfactorDelete a TOTP factor Requires a first-party interactive Account credential authenticated no more than 300 seconds ago.
- DeletevoiceprofileDelete Voice profile Deletes an additional profile when expectedVersion matches.
- DeletevoiceprofileinboundDelete Voice inbound configuration Removes a profile's inbound destination when the shared profile version matches.
- DeletevoiceprofileoutboundRevoke Voice outbound credential Revokes outbound calling for a profile when the shared profile version matches.
- DeletewebhookdestinationDelete webhook destination Deletes the selected project's destination and returns its stable tombstone.
- DisconnectwhatsappbusinessaccountDisconnect WhatsApp Business account Disconnects every attached WhatsApp sender, then unsubscribes our app and removes the project's…
- GetuserGet an User Returns one User after refreshing its Human or Agent classification and project ownership where supported.
- LeaveorganizationLeave an organization.
- MarkmessagereadMark a Message as read Persists a request to mark one incoming Message as read using its receiving account.
- ProvisionimessagededicatedlineProvision dedicated iMessage line Claims one dedicated iMessage line for the project and enables iMessage on it.
- ProvisionwhatsappdedicatedlineProvision dedicated WhatsApp line Provisions one dedicated WhatsApp line with WhatsApp and shared Voice enabled.
- PurchasesmsnumberPurchase SMS number Buys one US local number from the provider and records it as a resource with SMS enabled.
- QuerymessagemetricsQuery metrics Runs read-only SQL over the Project's message_events or call_events table.
- ReleaseimessagededicatedlineRelease dedicated iMessage line Removes only iMessage from one dedicated line.
- ReleaseresourceRelease resource Gives one resource back, whatever it is.
- ReleasesharedlineassignmentRelease shared line assignment Releases a shared line assignment, freeing both its seat and its handle for reassignment.
- ReleasewhatsappdedicatedlineRelease dedicated WhatsApp line Removes only WhatsApp from one dedicated line.
- ReleasewhatsappsharedlineassignmentRelease WhatsApp shared line assignment Releases a WhatsApp shared line assignment, freeing its seat for reassignment.
- ResetaccountprofilepictureRemove profile picture Removes the authenticated account's custom profile picture and returns the account using its default picture.
- ResetagentprofileavatarReset agent avatar Replaces the selected project's agent avatar with the project's default avatar, a generated planet image derived from…
- RevokeaccountservicekeyRevoke Account Service Key Revokes the account-owned service key identified by serviceKeyId and returns its revoked metadata.
- RevokeauthorizedapplicationRevoke connected application Revokes the authenticated user's grant for one OAuth application.
- SendmessageSend a Message Sends SMS, email, WhatsApp Personal, WhatsApp Business, iMessage, or Telegram text and image messages.
- SetspacetypingSet typing in a Space Saves one transient typing update as an authorized Agent in this Space.
- UnassignsmslinecampaignUnassign SMS line campaign Any project writer, including a scoped API key, may detach the campaign.
- UnassignvoicelineprofileUnassign Voice line profile Removes a line's explicit override when the resource version matches so the line follows the project default.
- UpdateaccountUpdate account Updates the supplied firstName and lastName fields on the authenticated account and returns the updated profile.
- UpdateagentprofileUpdate agent profile Updates the supplied firstName and lastName fields in the project's agent profile and returns the updated profile.
- UpdatedefaultvoiceprofileUpdate default Voice profile Patches the default profile's protocol or mediaEncryption when expectedVersion matches.
- UpdateprojectUpdate project Updates the identified project's name and returns the updated project.
- UpdatevoiceprofileUpdate Voice profile Patches an additional profile's name, protocol, or mediaEncryption when expectedVersion matches.
- UpdatevoiceprofileoutboundauthenticationUpdate Voice outbound authentication Changes a SIP profile's outbound Digest algorithm when expectedVersion matches.
- UpdatewebhookdestinationUpdate webhook destination Updates the supplied URL, name, description, status or enabledEvents fields on a project's webhook destination…
- VerifytotpenrollmentVerify TOTP enrollment Requires a first-party interactive Account credential authenticated no more than 300 seconds ago.
