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

Add an iMessage sandbox contact

Adds your own phone (E.164) or Apple ID email. The contact starts as pending; it becomes active when its joinText arrives at the sandbox line from that handle (joinLink opens Messages with it prefilled). Adding a handle that is already on your list returns it unchanged.

POST
/v1/imessage/sandbox/contacts

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

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.addImessageSandboxContact({  body: {    handle: 'string',  },});console.log(data);
{  "contact": {    "id": "string",    "handle": "string",    "status": "pending",    "joinText": "string",    "joinLink": "string",    "activatedAt": "2019-08-24T14:15:22Z",    "lastInboundAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z"  }}
Was this page helpful?

Add a participant to an iMessage group

Applied asynchronously by the provider; the participant list on the next group webhook reflects it.

Cancel an iMessage sender

Cancels the sender at the provider and deactivates its messaging account. Billing stops with the current month (no proration or refunds, matching phone numbers). A sender still being set up (status ordering or activating) cannot be canceled; contact support to change the order.

handle*string

Phone in international format (+15551234567) or an Apple ID email