Simulate Inbound User Event API Reference

Serverhttps://api.pinnacle.sh/

Simulate inbound messages and button presses from a user.

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for simulating an inbound event from a user.

Type

Simulate an inbound message from a user.

fromstring

User phone number in E.164 format.

Example

"+14155551234"

tostring

Receiver phone number in E.164 format or RCS agent ID (prefixed with agent_).

Example

"+14155555678"

object

User message payload. At least one of text or mediaUrls must be non-empty. Send only text to simulate an inbound SMS; include mediaUrls to simulate an inbound MMS.

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

const client = new PinnacleClient({
  apiKey: process.env.PINNACLE_API_KEY!,
});

await client.messages.simulate.user({
    from: "+14155551234",
    to: "+14155555678",
    message: {
        text: "Hello from the test user!"
    }
});

Responses

{  "success": true}

Simulate Inbound User Event

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

500application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`