Skip to main content
GET
Count Messages

Authorizations

Authorization
string
header
required

Account Service Key, prefixed with pho_ask_, sent as Authorization: Bearer <key>. Acts on behalf of its owning account, subject to the permissions and credential restrictions of each operation. Account access tokens and OAuth grants also use the Bearer header. In organizations that require SSO, Account Service Keys are not accepted for managing the organization's SSO settings, deleting the organization, or checking whether it can be deleted.

Path Parameters

id
string
required
Pattern: ^pho_prj_[0-7][0-9a-hjkmnp-tv-z]{25}$

Query Parameters

createdBefore
string<date-time>

Exclusive upper bound on createdAt, RFC 3339. Cannot combine with updatedAt bounds.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
createdSince
string<date-time>

Inclusive lower bound on createdAt, RFC 3339. Cannot combine with updatedAt bounds.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
direction
enum<string>

Message origin: received or dispatched, including later delivery outcomes

Available options:
received,
sent
excludeContentTypes
string

Comma-separated content types to exclude from resource-scoped Message lists and counts. Requires resourceId. A group is excluded when group is selected or all of its parts are excluded; retained Messages are unchanged. Supported values: attachment, group, message.delete, message.read, poll, poll.update, poll.vote, reaction, space.participants.update, space.typing.update, text, text.update, voice.

Maximum string length: 1024
perspectiveUserId
string

Selects this User's sent or received Messages. Requires spaceId; cannot combine with resourceId.

Pattern: ^pho_usr_[0-7][0-9a-hjkmnp-tv-z]{25}$
platform
enum<string>

Restricts the page to one platform

Available options:
sms,
email,
whatsapp,
whatsapp_business,
imessage,
telegram
resourceId
string

Resource associated with the Message when sent or received. Can combine with spaceId, but not perspectiveUserId.

Pattern: ^pho_res_[0-7][0-9a-hjkmnp-tv-z]{25}$
spaceId
string

Requires resourceId or perspectiveUserId. User perspectives use created_at order and exclude time bounds and platform filters.

Pattern: ^pho_spc_[0-7][0-9a-hjkmnp-tv-z]{25}$
updatedBefore
string<date-time>

Exclusive upper bound on updatedAt, RFC 3339. Cannot combine with createdAt bounds.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
updatedSince
string<date-time>

Inclusive lower bound on updatedAt, RFC 3339. Cannot combine with createdAt bounds.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
groupBy
string

Split counts into received and sent groups.

Allowed value: "direction"
interval
string

Calendar-day counts by Message.createdAt

Allowed value: "day"
timeZone
string

IANA zone for calendar-day buckets; defaults to UTC; requires interval

Required string length: 1 - 100

Response

Matching Message count, optional direction groups and daily buckets

count
integer
required
Required range: 0 <= x <= 9007199254740991
groups
object[]