Get Contact Capabilities

Check which messaging channels a phone number supports, without sending a message.

Runs a live check (typically 1-2 seconds), so the result reflects the number right now. Capabilities can still change by the time you send. Requires at least one active iMessage-capable or RCS number on the account; each flag is null when your account holds no line that could act on it (rcs reachability is checked against YOUR agents, so it can differ per account while an agent is pre-launch).

Check which messaging channels a phone number supports, without sending a message. Runs a live check (typically 1-2 seconds), so the result reflects the number right now. Capabilities can still change by the time you send. Requires at least one active iMessage-capable or RCS number on the account; each flag is null when your account holds no line that could act on it (rcs reachability is checked against YOUR agents, so it can differ per account while an agent is pre-launch).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

phone_numberstringRequired

Phone number to check (E.164 preferred; URL-encode + as %2B)

Response

Successful Response

phoneNumberstring

capabilitiesobject

checkedAtdatetime

Errors

422

Unprocessable Entity Error

1	import { AgentPhoneClient } from "agentphone";
2
3	async function main() {
4	const client = new AgentPhoneClient({
5	token: "YOUR_TOKEN_HERE",
6	});
7	await client.contacts.getContactCapabilities({
8	phoneNumber: "phone_number",
9	});
10	}
11	main();

1	{
2	"phoneNumber": "string",
3	"capabilities": {
4	"imessage": true,
5	"sms": true,
6	"rcs": true
7	},
8	"checkedAt": "2024-01-15T09:30:00Z"
9	}