campaigns > RCS

Get RCS Campaign by ID

Retrieve RCS campaign.

get/campaigns/rcs/{campaignId}

Request

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

Path parameters

campaignIdstring required

Unique identifier of the RCS campaign. Must begin with the prefix rcs_.

Response

Successfully retrieved.

agentIdstring required

Agent's unique identifier.

campaignIdstring

Unique identifier for the campaign. This identifier is a string that always begins with the prefix rcs_, for example: rcs_1234567890.

expectedAgentResponsesstring[]

List of what the agent might say to users. See the Expected Agent Responses section for requirements.

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.

useCaseDescriptionstring

Detailed summary of what the brand is and how this agent will be used. See the Use Case Behavior section for requirements.

messagingType'OTP' | 'TRANSACTIONAL' | 'PROMOTIONAL' | 'MULTI_USE'

Type of message the agent sends.<br>

OTP: One time passwords or verification codes. <br> TRANSACTIONAL: Account updates, alerts, or notifications.<br> PROMOTIONAL: Marketing, sales, or offers.<br> MULTI_USE: Mixed message types.<br>

ctaMediastring

URL to the opt-in form or a URL to a screenshot of the opt-in CTA.

optInMethodstring

Details on how opt-in is acquired. If it is done through a website or app, provide the link. See the Opt-In Method section for requirements.

ctaLanguagestring

Required text that appears next to the opt-in checkbox for your opt-in form. This checkbox has to be unchecked by default. See the CTA Language section for requirements.

demoTriggerstring

Instructions on how an external reviewer can trigger messages and an example flow from the agent. This is usually an inbound text message to the agent that will start a flow of messages between the agent and the user. See the Demo Trigger section for requirements.

Changes

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