Get RCS Campaign by ID

GET

https://api.pinnacle.sh/campaigns/rcs/:campaignId

GET

/campaigns/rcs/:campaignId

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.campaigns.rcs.get("rcs_1234567890");
8 }
9 main();

Try it

1 {
2   "agent": {
3     "emails": [
4       {
5         "email": "founders@trypinnacle.app",
6         "label": "Email Us"
7       }
8     ],
9     "phones": [
10       {
11         "label": "Contact us directly",
12         "phone": "+14154467821"
13       }
14     ],
15     "websites": [
16       {
17         "label": "Get started with Pinnacle",
18         "url": "https://www.trypinnacle.app/"
19       }
20     ],
21     "color": "#000000",
22     "description": "Experience the power of RCS messaging with interactive demos. Test rich features like carousels, suggested replies, and media sharing. Get started with our developer-friendly APIs.",
23     "heroUrl": "https://pncl.to/D6pDSqGxqgfbCfQmw4gXdnlHu4uSB4",
24     "iconUrl": "https://pncl.to/mq_tdIDenRb5eYpJiM8-3THCaUBrZP",
25     "name": "Pinnacle - RCS Demo"
26   },
27   "agentId": "agent_V1StGXR8_Z5j",
28   "brand": {
29     "createdAt": "2024-08-17T08:00:30.632",
30     "id": "b_1234567890",
31     "isArchived": false,
32     "status": "VERIFIED",
33     "updatedAt": "2024-12-09T10:03:54.934",
34     "address": "500 Folsom Street, San Francisco, CA 94105",
35     "contact": {
36       "email": "janedoe1@pinnacle.example",
37       "name": "Jane Doe",
38       "phone": "+14155550123",
39       "title": "Customer Support Specialist"
40     },
41     "dba": "Pinnacle RCS",
42     "ein": "12-3456789",
43     "email": "founders@trypinnacle.app",
44     "name": "Pinnacle",
45     "sector": "TECHNOLOGY",
46     "type": "PRIVATE_PROFIT",
47     "website": "https://www.pinnacle.sh/"
48   },
49   "status": "VERIFIED",
50   "campaignId": "rcs_1234567890",
51   "expectedAgentResponses": [
52     "Here are the things I can help you with.",
53     "I can assist you with booking an appointment, or you may choose to book manually.",
54     "Here are the available times to connect with a representative tomorrow.",
55     "Your appointment has been scheduled."
56   ],
57   "links": {
58     "privacyPolicy": "https://www.pinnacle.sh/privacy",
59     "termsOfService": "https://www.pinnacle.sh/terms"
60   },
61   "useCase": {
62     "behavior": "Pinnacle is a developer-focused RCS assistant that helps teams design, test, and optimize rich messaging experiences across SMS, MMS, and RCS. The agent acts as both an “onboarding guide” for new customers and a “best-practices coach” for existing teams exploring higher-value RCS workflows like rich cards, carousels, and suggested actions.<br>\n\nThe agent delivers a mix of operational updates and educational content (2–6 messages/month). Content includes important platform notices (e.g., deliverability or throughput changes), implementation tips with sample RCS templates, and personalized recommendations on how to upgrade existing SMS campaigns into richer, higher-converting RCS conversations.\n",
63     "value": "OTHER"
64   },
65   "optInTermsAndConditions": "We ensure consent through an explicit opt-in process that follows 10DLC best practices.Users must agree to receive messages from Pinnacle before the agent sends them any messages.<br>\n\nUsers agree to these messages by signing an opt-in paper form that they can be found online at https://www.pinnacle.sh/opt-in. We only send messages once users have filled out the form and submitted it to us via email or through the dashboard.\n",
66   "messagingType": "MULTI_USE",
67   "carrierDescription": "Demonstrate the power of RCS to medium and large companies already sending massive SMS/MMS volumes through our platform. These clients send conversational messages in industries such as commerce, appointments, and customer support.",
68   "keywords": {
69     "HELP": {
70       "message": "Email founders@trypinnacle.app for support.",
71       "keywords": [
72         "HELP",
73         "SUPPORT"
74       ]
75     },
76     "OPT_IN": {
77       "message": "Welcome back to Pinnacle!<br>\n🔔 You're now subscribed to Pinnacle - RCS Demo and will continue receiving important updates and news. Feel free to contact this us at any time for help.<br>\n\nReply STOP to opt out and HELP for support. Message & rates may apply.\n",
78       "keywords": [
79         "START",
80         "SUBSCRIBE"
81       ]
82     },
83     "OPT_OUT": {
84       "message": "You’ve been unsubscribed from Pinnacle and will no longer receive notifications. If you ever change your mind, reply START or SUBSCRIBE to rejoin anytime.",
85       "keywords": [
86         "STOP",
87         "UNSUBSCRIBE",
88         "END"
89       ]
90     }
91   },
92   "traffic": {
93     "monthlyWebsite": 10000,
94     "monthlyRcsEstimate": 10000
95   },
96   "agentTriggers": "The agent sends the first message when the user subscribes to Pinnacle. Messages are based on user actions such as pressing suggestion buttons. External triggers such as reminders can be setup by users in advance for a later time.",
97   "interactionDescription": "The agent’s primary interaction will be customer service — helping users with questions, troubleshooting issues, and providing quick assistance through chat. Other interactions include appointment management and sending notifications to the user.",
98   "isConversational": true,
99   "ctaLanguage": "By checking this box and submitting this form, you consent to receive transactional text messages for support, appointment, and reminder messages from Pinnacle Software Development Inc. Reply STOP to opt out. Reply HELP for help. Standard message and data rates may apply. Message frequency may vary. View our Terms and Conditions at https://www.pinnacle.sh/terms. View our Privacy Policy at https://www.pinnacle.sh/privacy.",
100   "demoTrigger": "Text \"START\" to trigger the flow."
101 }

Retrieve RCS campaign.

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Path parameters

campaignIdstringRequired

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

Response

Successfully retrieved.

agentobject

Agent configured to the campaign.

agentIdstring

Agent's unique identifier.

brandobject

Brand associated with this campaign.

statusenum

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

Allowed values:

campaignIdstring or null

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

expectedAgentResponseslist of strings or null

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

linksobject or null

Legal documentation links.

useCaseobject or null

Use case classification for the campaign.

optInTermsAndConditionsstring or null

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

messagingTypeenum or null

Type of message the agent sends.

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

Allowed values:

carrierDescriptionstring or null

Description of the agent’s purpose, shown to carriers for approval. See the Carrier Description section for requirements.

keywordsobject or null

trafficobject or null

agentTriggersstring or null

Explanation of how the agent is triggered. This includes how the first message is delivered, whether messages follow a schedule or triggered by user actions, and any external triggers. See the Agent Triggers section for requirements.

interactionDescriptionstring or null

Description of all agent interactions, including primary and secondary use cases. See the Interaction Description section for requirements.

isConversationalboolean or null

Whether the agent supports conversational flows or respond to P2A messages from the users. Set to false for one-way messages from agent to user.

ctaLanguagestring or null

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 or null

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.

Authentication

Path parameters

Response

Errors