Get Toll-Free Campaign Status | Pinnacle

Retrieve a toll-free campaign’s status.

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Path parameters

campaignIdstringRequired

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.

Response

Successfully retrieved.

idstring

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

updatesobject

Status of phone numbers that are being attached to this campaign.

Note that phone numbers can only be attached to VERIFIED campaigns via the attach campaign endpoint.

errorstring or null

Summary of errors related to the verification process.

These errors may request additional information or point out erroneous and/or missing fields.

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.tollFree("tf_1234567890");
8	}
9	main();

1	{
2	"id": "tf_1234567890",
3	"updates": {
4	"errors": [],
5	"number": "+14151234567",
6	"status": "IN_PROGRESS"
7	},
8	"error": ""
9	}

Authentication

Path parameters

Response

Errors