Get 10DLC Campaign Status | Pinnacle

Retrieve a 10DLC campaign's status.

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Path parameters

campaignIdstringRequired

The unique identifier of the 10DLC campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix dlc_, for example: dlc_1234567890.

Response

Successfully retrieved.

errorstring

Summary of errors related to the verification process.

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

idstring

The unique identifier of the 10DLC campaign. This identifier is a string that always begins with the prefix dlc_, for example: dlc_1234567890.

statusenum

Current review status of the DLC campaign.

INCOMPLETE: Not submitted.
IN REVIEW: Being reviewed by carriers.
VERIFIED: Approved and ready to send messages.
FAILED: Issues and errors related to the campaign’s details. See error for these potential issues.

Current review status of the DLC campaign. <br> `INCOMPLETE`: Not submitted.<br> `IN REVIEW`: Being reviewed by carriers.<br> `VERIFIED`: Approved and ready to send messages.<br> `FAILED`: Issues and errors related to the campaign's details. See [error](dlc-campaign#response.body.error) for these potential issues.

Allowed values:

updatesobject

Status of local long code numbers that are being attached to this campaign.

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

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

1	{
2	"error": "",
3	"id": "dlc_1234567890",
4	"status": "IN REVIEW",
5	"updates": {
6	"number": "+14151234567",
7	"status": "PENDING_ASSIGNMENT",
8	"errors": []
9	}
10	}

Authentication

Path parameters

Response

Errors