Get RCS Campaign by ID

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(161); 8 } 9 main();

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": "Engaging campaigns with RBM – next-gen SMS marketing with rich content and better analytics.", 23 "heroUrl": "https://agent-logos.storage.googleapis.com/_/m0bk9mmw7kfynqiKSPfsaoc6", 24 "iconUrl": "https://agent-logos.storage.googleapis.com/_/m0bk9gvlDunZEw1krfruZmw3", 25 "name": "Pinnacle Software Development" 26 }, 27 "agentId": "agent_V1StGXR8_Z5j", 28 "brand": { 29 "createdAt": "2024-08-17T08:00:30.632", 30 "id": 2, 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 "brandVerificationUrl": "https://www.pinnacle.sh/articles-of-incorporation.pdf" 49 }, 50 "brandAttestation": true, 51 "status": "VERIFIED", 52 "brandVerificationUrl": "https://www.pinnacle.sh/articles-of-incorporation.pdf", 53 "campaignId": 161, 54 "expectedAgentResponses": [ 55 "Here are the things I can help you with.", 56 "I can assist you with booking an appointment, or you may choose to book manually.", 57 "Here are the available times to connect with a representative tomorrow.", 58 "Your appointment has been scheduled." 59 ], 60 "links": { 61 "privacyPolicy": "https://www.trypinnacle.app/privacy", 62 "termsOfService": "https://www.trypinnacle.app/terms" 63 }, 64 "optIn": { 65 "method": "WEBSITE", 66 "termsAndConditions": "Would you like to subscribe to Pinnacle?" 67 }, 68 "optOut": { 69 "description": "Reply STOP to opt-out anytime.", 70 "keywords": [ 71 "STOP", 72 "UNSUBSCRIBE", 73 "END" 74 ] 75 }, 76 "useCase": { 77 "behavior": "Acts as a customer service representative.", 78 "value": "OTHER" 79 } 80 }

Retrieve RCS campaign.

Path parameters

campaignIdintegerRequired>=1

Unique identifier of the RCS campaign.

Response

Successfully retrieved.

agentobject

Agent configured to the campaign.

agentIdstring

Agent's unique identifier.

brandobject

Brand associated with this campaign.

brandAttestationboolean

Indicates whether the brand has provided an attestation.

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:

brandVerificationUrlstring or null

Link to document verifying the brand's name. This may be the certificate of incorporation, business license, or other relevant document. You can typically find this on the Secretary of State website.

campaignIdinteger or null

Unique identifier for the campaign.

expectedAgentResponseslist of strings or null

List of what the agent might say to users.

linksobject or null

Legal documentation links.

optInobject or null

Opt-in configuration.

optOutobject or null

Opt-out configuration.

useCaseobject or null

Use case classification for the campaign.

Path parameters

Headers

Response

Errors