Skip to main content
GET
/
contacts
/
lookup
Check whether a phone can receive messages
curl --request GET \
  --url https://{tenantDomain}.sinjapp.org/api/v1/contacts/lookup \
  --header 'X-Api-Key: <api-key>'
{
  "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 TGO Connect.

​
exists
boolean
​
can_receive
boolean
​
reason_code
string
Example:

"ok"

​
recipient_id
integer | null
​
is_verified
boolean
​
phone_verified_at
string<date-time> | null