Lookup a phone number

client.lookups.lookupNumber(, ?): LookupLookupNumberResponse { number, service }

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.

ParametersExpand Collapse

query: LookupLookupNumberParams { number }

number: string

The number you want to evaluate in E.164 format

ReturnsExpand Collapse

LookupLookupNumberResponse { number, service }

number?: string

The number you evaluated in E.164 format

service?: "iMessage" | "SMS"

The service the number supports

Accepts one of the following:

"iMessage"

"SMS"

Lookup a phone number

import SendblueAPI from 'sendblue';

const client = new SendblueAPI({
  apiKey: process.env['SENDBLUE_API_API_KEY'], // This is the default and can be omitted
  apiSecret: process.env['SENDBLUE_API_API_SECRET'], // This is the default and can be omitted
});

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

console.log(response.number);

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

Returns Examples

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