API ReferenceStatus

Get 10DLC Campaign Status

Retrieve a 10DLC campaign's status.

Path parameters

campaignIdintegerRequired>=1
ID of the 10DLC campaign.

Headers

PINNACLE-API-KEYstringRequired

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.

idinteger
Id of the DLC campaign.
statusenum
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.

Errors