Get Toll-Free Campaign Status API Reference

Serverhttps://api.pinnacle.sh/

Retrieve a toll-free campaign's status.

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Path Parameters

campaignIdstring

The unique identifier of the toll-free campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix tf_, for example: tf_1234567890.

Example

"tf_1234567890"

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.tollFree("tf_1234567890");

Responses

{  "id": "tf_1234567890",  "updates": {    "number": "+14151234567",    "status": "IN_PROGRESS",    "errors": []  },  "error": ""}

Get Toll-Free Campaign 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`