Get Phone Number Status API Reference

Serverhttps://api.pinnacle.sh/

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

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

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Path Parameters

phoneNumberstring

Phone number in E164 format that is in review.

Example

"+14151234567"

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

const client = new PinnacleClient({
  apiKey: process.env.PINNACLE_API_KEY!,
});

await client.status.get.phoneNumber("+14151234567");

Responses

{  "phoneNumber": "+14151234567",  "status": "PENDING",  "errors": []}

Get Phone Number Status

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

501application/json

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`