Get Phone Number Status | Pinnacle

Retrieve a phone number’s order status and campaign attachment status.

Check if a number is active and ready to send messages.

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Path parameters

phoneNumberstringRequired

Phone number in E164 format that is in review.

Response

Successfully retrieved.

errorslist of strings

List of errors that occured.

phoneNumberstring

Phone number in E164 format that is in review

statusenum

Current status of the phone number.

PENDING: Not active during the one or more of the following: purchase pending, brand or campaign pending verification, and pending assignment to a campaign. To use a number, make sure to attach it to an active campaign.
ACTIVE: Number is ready to send messages.
FAILURE: Errors occurred while activating this number. See the errors field.

Current status of the phone number. <br> `PENDING`: Not active during the one or more of the following: purchase pending, brand or campaign pending verification, and pending assignment to a campaign. To use a number, make sure to [attach it](../phone-numbers/attach-campaign) to an active campaign. <br> `ACTIVE`: Number is ready to send messages. <br> `FAILURE`: Errors occurred while activating this number. See the [errors field](phone-number#response.body.errors).

Allowed values:

1	import { PinnacleClient } from "rcs-js";
2
3	async function main() {
4	const client = new PinnacleClient({
5	environment: "https://api.pinnacle.sh",
6	});
7	await client.status.get.phoneNumber("+14151234567");
8	}
9	main();