status > get

Get Phone Number Status

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

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

get/status/phone-number/{phoneNumber}

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/status/phone-number/{phoneNumber}
  • Auth: API key in header PINNACLE-API-KEY

Path parameters

phoneNumberstring required

Phone number in E164 format that is in review.

Response

Successfully retrieved.

errorsstring[] required

List of errors that occured.

phoneNumberstring required

Phone number in E164 format that is in review

status'PENDING' | 'ACTIVE' | 'FAILURE' required

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. ACTIVE: Number is ready to send messages. FAILURE: Errors occurred while activating this number.

Changes

No recorded changes to this operation across all 1 revision of this API.