status > get

Get 10DLC Campaign Status

Retrieve a 10DLC campaign's status.

get/status/dlc-campaign/{campaignId}

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/status/dlc-campaign/{campaignId}
  • Auth: API key in header PINNACLE-API-KEY

Path parameters

campaignIdstring required

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 required

Summary of errors related to the verification process. <br>

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

idstring required

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

status'INCOMPLETE' | 'IN REVIEW' | 'VERIFIED' | 'FAILED' required

Current review status of the 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.

Changes

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