Skip to main content
GET
Get the activity of a trial
  • Credential: the trial key of the trial, and no other credential: an API key returns 401 unauthorized. See Trial key.
  • Events: none.
  • Personal data: paired_handle, the prospect’s phone number or the email address of their Apple ID. Request it only when needed, do not copy it into logs, tickets or other tools, and refer to a prospect by an id of your own.
  • Counters: messages_sent_total and messages_received_total count the messages of the trial that iSnap still keeps, not the life of the trial: see Activity.

Errors

The errors that every operation shares are in Errors.

Authorizations

Authorization
string
header
required

An API key created in the iSnap dashboard, or a trial key, sent as Authorization: Bearer <key>. An API key starts with isnap_live_ or isnap_test_; both act on the same account, lines and billing. A trial key acts on its trial only.

Response

The status and the counts of the trial.

success
enum<boolean>
required

Always true on a success response.

Available options:
true
data
object
required

The status and the message counts of a trial.

trace_id
string
required

Trace id of the request that produced this response: 32 lowercase hexadecimal characters. Quote it when you report a problem to iSnap.

request_id
string
required

Id of the request that produced this response: req_ followed by 25 letters or digits.