Check whether a phone can receive messages

Error

A valid request URL is required to generate request examples

{
  "exists": true,
  "can_receive": true,
  "reason_code": "ok",
  "recipient_id": 123,
  "is_verified": true,
  "phone_verified_at": "2023-11-07T05:31:56Z"
}

GET

contacts

lookup

Error

A valid request URL is required to generate request examples

{
  "exists": true,
  "can_receive": true,
  "reason_code": "ok",
  "recipient_id": 123,
  "is_verified": true,
  "phone_verified_at": "2023-11-07T05:31:56Z"
}

Authorizations

X-Api-Key

string

header

required

Query Parameters

phone

string

required

sender_number_id

integer

sender_phone

string

Response

Lookup result from Sinjapp.

exists

boolean

can_receive

boolean

reason_code

string

Example:

"ok"

recipient_id

integer | null

is_verified

boolean

phone_verified_at

string<date-time> | null