Zernio
Zernio
API Reference

iMessage

List iMessage audienceGETList instantly available iMessage numbersGETList iMessage sandbox contactsGETList iMessage sender ordersGETList iMessage sendersGETStart an iMessage group chatPOSTCreate a tracked iMessage opt-in linkPOSTGet an iMessage groupGETGet iMessage sender statusGETSubscribe or opt out an iMessage contactPOSTRename an iMessage group or change its photoPATCHUpdate an iMessage senderPATCHAdd a participant to an iMessage groupPOSTAdd an iMessage sandbox contactPOSTCancel an iMessage senderDELETEOrder a new iMessage senderPOSTRegister an iMessage senderPOSTRemove a participant from an iMessage groupDELETERemove an iMessage sandbox contactDELETEReserve an available iMessage numberPOST
Dashboard
llms.txtOpenAPI
OverviewPlatformsAPI ReferenceResources
iMessage

List iMessage audience

Contacts who have messaged your iMessage senders (1:1 threads), with subscription state and, for threads opened through a tracked opt-in link, the parameters that brought them in. Newest activity first.

GET
/v1/imessage/audience

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

Query Parameters

accountId?string

Limit to one sender account

status?string

Value in

  • "subscribed"
  • "unsubscribed"
search?string

Matches the contact handle or name

Lengthlength <= 120
limit?integer
Range1 <= value <= 200
Default50
skip?integer
Range0 <= value
Default0

Response Body

application/json

application/json

application/json

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.imessage.listImessageAudience();console.log(data);
{  "contacts": [    {      "conversationId": "string",      "accountId": "string",      "contact": "string",      "name": "string",      "subscribed": true,      "lastMessage": "string",      "lastMessageAt": "2019-08-24T14:15:22Z",      "firstSeenAt": "2019-08-24T14:15:22Z",      "optIn": {        "at": "2019-08-24T14:15:22Z",        "parameters": {}      }    }  ],  "total": 0,  "limit": 0,  "skip": 0}
Was this page helpful?

Get pricing analytics

Message volume and approximate cost for one connected WhatsApp number, read live from Meta's `pricing_analytics` on the WhatsApp Business Account and scoped to that account's phone number. Meta's figures are approximate and can lag; Meta bills from its own invoice. Meta limits how far back and how fine the data goes (for example HALF_HOUR only over short ranges) and answers out-of-range requests with an error.

List instantly available iMessage numbers

Phone numbers the provider has already registered and can assign on the spot. Order one by passing its `id` as `availableNumberId` to POST /v1/imessage/senders/order: the sender activates immediately instead of after the usual provisioning wait. Reserve it first with POST /v1/imessage/senders/available-numbers/{numberId}/reserve while the buyer decides. The list is a snapshot; a number can be taken between listing and ordering.