Lookup Number

API Reference

Lookups

Lookup a phone number

client.lookups.lookupNumber(LookupLookupNumberParamsquery, RequestOptionsoptions?): numberstringserviceunionLookupLookupNumberResponse

get/api/evaluate-service

Determine if a phone number supports iMessage or SMS. Useful for checking if a number is an iPhone, if it is real, or which provider to use.

Parameters

querynumberstringLookupLookupNumberParams

Hide ParametersShow Parameters

numberstring

The number you want to evaluate in E.164 format

Returns

LookupLookupNumberResponse

Hide ParametersShow Parameters

numberstring

optional

The number you evaluated in E.164 format

serviceunion

optional

"iMessage" | "SMS"

The service the number supports

Hide ParametersShow Parameters

"iMessage"

"SMS"

HTTPTypeScript

import SendblueAPI from 'sendblue';

const client = new SendblueAPI({
  apiKey: 'My API Key',
  apiSecret: 'My API Secret',
});

const response = await client.lookups.lookupNumber({ number: '+19999999999' });

console.log(response.number);

200 Example

{
  "number": "+19999999999",
  "service": "iMessage"
}