How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Vibes RCS Business Messaging API

Vibes RCS for Business (RBM) API — check a device's RCS capabilities, send RCS agent messages and events, revoke an undelivered message, and manage agent tester devices. Authenticated with OAuth 2.0 client credentials against a Vibes-operated AWS Cognito authorization server, using the scope https://rbm.vibes.com/rbm.agents. The only OAuth-secured surface Vibes ships.

Vibes RCS Business Messaging API is one of 12 APIs that Vibes Platform publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include RCS, Rich Communication Services, and Mobile Messaging. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 8 operations across 6 paths, and defines 36 schemas. It is described by OpenAPI 3.1.0, at version 0.0.0.

Requests are made against a single base URL, https://rbm.us.vibes.com/connectCustomers.

8 operations 6 paths 36 schemas 2 DELETE3 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.0.0
Base URL
https://rbm.us.vibes.com/connectCustomers
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Vibes RCS Business Messaging API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2Auth) using the clientCredentials flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 2 DELETE, 3 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

RCS Business Messaging 8
GET
/{connect_customer_key}/capabilities/{msisdn}
Check for RCS capabilities
Get Mobile Device Capabilities 4 params → 200403404422429
POST
/{connect_customer_key}/agentMessages/{msisdn}
Send an RCS message
Send Agent Message 4 params body → 200403422429
POST
/{connect_customer_key}/agentEvents/{msisdn}
Send an RCS event
Send Agent Event 4 params body → 200403422429
DELETE
/{connect_customer_key}/agentMessages/{msisdn}/{messageId}
Revoke an RCS message
Revoke Agent Message 4 params → 200403422429
POST
/{connect_customer_key}/testers/{msisdn}
Invite an agent tester
Invite Agent Tester 3 params → 200403422429
GET
/{connect_customer_key}/testers/{msisdn}
Get the invite status of a tester device
getTester 3 params → 200400401403
DELETE
/{connect_customer_key}/testers/{msisdn}
Delete a tester device
deleteTester 3 params → 200400401403
GET
/{connect_customer_key}/testers
List the invite statuses of tester devices
listTesters 2 params → 200400401403

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are AgentMessage (9 properties), SuggestedAction (8 properties), AgentContentMessage (5 properties), AgentEvent (4 properties). Each schema is shown below with its type and property counts.

AgentContentMessage
object
The content of the agent message.
5 properties
AgentEvent
object
4 properties 1 required
AgentEventType
string
AgentMessage
object
9 properties 1 required
ApiError
object
1 property
Capabilities
object
2 properties 1 required
CardContent
object
Each rich card must have at least one of title, description, or media.
4 properties
CardOrientation
string
CarouselCard
object
A carousel of rich cards.
2 properties
ContentInfo
object
3 properties
CreateCalendarEventAction
object
4 properties
DialAction
object
1 property
Feature
string
LatLng
object
2 properties
Media
object
3 properties
MediaHeight
string
OpenUrlAction
object
4 properties
OpenUrlApplication
string
What app the URL will open in - browser or integrated webview window.
RichCard
object
2 properties
ShareLocationAction
object
StandaloneCard
object
3 properties
SuggestedAction
object
8 properties
SuggestedReply
object
2 properties
Suggestion
object
2 properties
Tester
object
4 properties 1 required
TesterInviteStatus
string
ThumbnailImageAlignment
string
Alignment of image preview for standalone cards with horizontal layout.
ViewLocationAction
object
Opens the device's default map app and selects the specified location or searches around the device's location given an agent-specified query.
3 properties
WebviewViewMode
string
If URL is opened in integrated webview, specify view mode. Default is full view.
CardWidth
string
MessageTrafficType
string
RichMessageClassificationType
string
RichMessageClassification
object
Output only. Classifies the message according to the US billing model.
2 properties
UploadedRbmFile
object
A file that has been uploaded to the RCS Business Messaging platform.
2 properties
UserFile
object
3 properties
SuggestionResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vibes-platform-rcs-business-messaging-openapi.json Raw ↑

Other APIs Vibes Platform publishes across the network.

Vibes Platform API
Vibes Platform Acquisition Campaigns API
Vibes Platform Broadcasts API
Vibes Platform Callbacks API
Vibes Platform Carrier Lookup API
Vibes Platform Events API
Vibes Platform Inbound Messages API
Vibes Platform Messages API
Vibes Platform Persons API
Vibes Platform Subscription Lists API
Vibes Platform Wallet Passes API
Where this information came from

This is an independent, third-party profile of Vibes RCS Business Messaging API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.