How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Matomo MobileMessaging API

The Matomo MobileMessaging API exposes 12 operations of the Matomo Reporting API (module `MobileMessaging`). SMS delivery configuration and phone-number verification for scheduled reports. Every operation is dispatched through the single `/index.php?module=API&method=MobileMessaging.` entrypoint on the customer's own Matomo instance, self-hosted or on Matomo Cloud. The OpenAPI 3.1.0 document is Matomo's own, generated by its first-party ApiReference plugin.

Matomo MobileMessaging API is one of 61 APIs that Matomo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Analytics, SMS, and Notification. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 12 operations across 12 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://demo-proxy.innocraft.cloud/.

12 operations 12 paths 4 schemas 12 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://{matomo_host}/index.php
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Matomo MobileMessaging API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (MatomoToken). By default, every request must be authenticated.

  • MatomoToken — Paste your token generated from Personal Security. Swagger will send it as a Bearer token.

Paths & Operations 12

Across 12 paths, the API surfaces 12 operations — 12 GET. Each is listed below with its method, path, parameters, and response codes.

MobileMessaging 12

The MobileMessaging API lets you manage SMS credentials, phone number verification, and SMS account settings.

GET
/index.php?module=API&method=MobileMessaging.areSMSAPICredentialProvided
Checks whether SMS API credentials are configured for the current user.
MobileMessaging.areSMSAPICredentialProvided 1 param → 200400401403404500default
GET
/index.php?module=API&method=MobileMessaging.getSMSProvider
Returns the configured SMS provider for the current user.
MobileMessaging.getSMSProvider 1 param → 200400401403404500default
GET
/index.php?module=API&method=MobileMessaging.setSMSAPICredential
Stores the SMS API credentials for the selected provider.
MobileMessaging.setSMSAPICredential 3 params → 200400401403404500default
GET
/index.php?module=API&method=MobileMessaging.addPhoneNumber
Adds a phone number for the current user and sends a verification code to it.
MobileMessaging.addPhoneNumber 2 params → 200400401403404500default
GET
/index.php?module=API&method=MobileMessaging.resendVerificationCode
Requests a new verification code for a pending phone number.
MobileMessaging.resendVerificationCode 2 params → 200400401403404500default
GET
/index.php?module=API&method=MobileMessaging.getCreditLeft
Returns the remaining SMS credit for the configured provider account.
MobileMessaging.getCreditLeft 1 param → 200400401403404500default
GET
/index.php?module=API&method=MobileMessaging.getPhoneNumbers
Returns the phone numbers configured for the current user.
MobileMessaging.getPhoneNumbers 1 param → 200400401403404500default
GET
/index.php?module=API&method=MobileMessaging.removePhoneNumber
Removes a phone number from the current user account.
MobileMessaging.removePhoneNumber 2 params → 200400401403404500default
GET
/index.php?module=API&method=MobileMessaging.validatePhoneNumber
Verifies a phone number using the submitted verification code.
MobileMessaging.validatePhoneNumber 3 params → 200400401403404500default
GET
/index.php?module=API&method=MobileMessaging.deleteSMSAPICredential
Deletes the configured SMS API credentials.
MobileMessaging.deleteSMSAPICredential 1 param → 200400401403404500default
GET
/index.php?module=API&method=MobileMessaging.setDelegatedManagement
Configures whether regular users can manage their own SMS API credentials.
MobileMessaging.setDelegatedManagement 2 params → 200400401403404500default
GET
/index.php?module=API&method=MobileMessaging.getDelegatedManagement
Returns whether regular users can manage their own SMS API credentials.
MobileMessaging.getDelegatedManagement 1 param → 200400401403404500default

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Error (3 properties), GenericSuccess (3 properties), ErrorXml (1 property), GenericSuccessXml (1 property). Each schema is shown below with its type and property counts.

GenericSuccess
object
Generic Matomo success payload.
3 properties 2 required
GenericSuccessXml
object
Generic Matomo success payload in XML.
1 property 1 required
Error
object
Generic Matomo error payload.
3 properties 2 required
ErrorXml
object
Generic Matomo error payload in XML.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

matomo-mobile-messaging-openapi.json Raw ↑

Other APIs Matomo publishes across the network.

Matomo Live API
Matomo Goals API
Matomo Segments API
Matomo Reporting API (index.php entrypoint)
Matomo Tracking API (matomo.php entrypoint)
Matomo SitesManager API
Matomo TagManager API
Matomo UsersManager API
Matomo CrashAnalytics API
Matomo HeatmapSessionRecording API
Matomo FormAnalytics API
Matomo Referrers API
Where this information came from

This is an independent, third-party profile of Matomo MobileMessaging API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.