Get RCS Campaign Status

Retrieve a RCS campaign's status.

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Path parameters

campaignIdstringRequired

The unique identifier of the RCS campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix rcs_, for example: rcs_1234567890.

Response

Successfully retrieved.
errorslist of strings
List of errors that occured.
idstring

The unique identifier of the RCS campaign. This identifier is a string that always begins with the prefix rcs_, for example: rcs_1234567890.

statusenum

Current review status of the RCS 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 errors for these potential issues.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
501
Not Implemented Error