Skip to main content
API docs by Redocly

Red Cloud CORE API (0.2.0)

Download OpenAPI specification:Download

Integration-ready REST reference for the Red Cloud public CORE API.

Contract-accurate OpenAPI spec derived from the current implementation.

Important realities reflected exactly:

  • OAuth uses client_credentials.
  • The token endpoint returns OAuth-style error bodies, not the CORE error wrapper.
  • sendFrom is a Red Cloud number identifier, not an E.164 phone number.
  • POST /api/core/messages/send requires Idempotency-Key.
  • campaignregId preserves the implemented request-field spelling.

Use this specification alongside the authored guides for:

  • first-send sequencing
  • authentication lifecycle behavior
  • queue and idempotency behavior
  • webhook lifecycle handling

Authentication

OAuth token issuance for Red Cloud CORE API access.

Issue a bearer access token

Issues a bearer access token using OAuth 2 client_credentials.

This endpoint supports:

  • HTTP Basic client authentication
  • request-body client_id and client_secret
  • form-encoded request fields

This endpoint returns OAuth-style error bodies, not the CORE error wrapper.

Request Body schema:
required
grant_type
required
string
Value: "client_credentials"
client_id
required
string
client_secret
required
string

Responses

Request samples

Content type
{
  • "grant_type": "client_credentials",
  • "client_id": "rc_test_client_123",
  • "client_secret": "rc_secret_abc123"
}

Response samples

Content type
application/json
{
  • "access_token": "rc_token_example",
  • "token_type": "bearer",
  • "expires_in": 3600
}

CORE

Authenticated CORE API routes for identity, numbers, and outbound messaging.

Return the current API client context

Returns the authenticated API client identity, capabilities, assigned-number summary, and webhook-configuration flags.

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "apiClientId": "rc_test_client_123",
  • "apiClientName": "Red Cloud Test Client",
  • "apiClientStatus": "ACTIVE",
  • "capabilities": [
    ],
  • "assignedNumbers": {
    },
  • "inboundWebhookConfigured": true,
  • "deliveryWebhookConfigured": true
}

List active numbers for the authenticated API client

Returns the Red Cloud numbers currently assigned to the authenticated API client. Use the returned numberId values as future sendFrom inputs.

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{}

Search available numbers

Searches available number inventory using supported location and numbering filters.

Authorizations:
BearerAuth
Request Body schema: application/json
required
npa
string
nxx
string
city
string
state
string
zipCode
string
rateCenter
string

Responses

Request samples

Content type
application/json
{
  • "npa": "555",
  • "city": "Austin",
  • "state": "TX"
}

Response samples

Content type
application/json
{
  • "groups": [
    ],
  • "providerResultCount": 1,
  • "requestedQuantity": 250
}

Update number settings

Updates supported number settings for a number owned by the authenticated API client. The request preserves the implemented field name campaignregId.

Authorizations:
BearerAuth
path Parameters
numberId
required
string
Example: num_abc123

Red Cloud number identifier.

Request Body schema: application/json
required
campaignregId
string or null
smsEnabled
boolean
mmsEnabled
boolean
webhookInboundOverride
string or null
webhookDeliveryOverride
string or null

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Queue an outbound message

Queues outbound messages through the existing Red Cloud pipeline.

Important:

  • Idempotency-Key is required.
  • sendFrom must be a Red Cloud number id.
  • SMS requests cannot include media.
  • MMS requests must include media.
  • successful synchronous acceptance returns QUEUED.
  • final delivery outcome is reported later by webhook.
Authorizations:
BearerAuth
header Parameters
Idempotency-Key
required
string
Example: idem_order_789
Request Body schema: application/json
required
sendFrom
required
string

Red Cloud number identifier. This is not an E.164 phone number.

to
required
Array of strings non-empty

One or more E.164 recipient phone numbers.

messageType
required
string
Enum: "SMS" "MMS"

Message mode. SMS forbids media. MMS requires media.

text
string

Message body text.

Array of objects (MessageMediaInput)

Required for MMS. Omit for SMS.

externalReference
required
string

Caller-defined business correlation key.

Responses

Request samples

Content type
application/json
Example
{
  • "sendFrom": "num_abc123",
  • "to": [
    ],
  • "messageType": "SMS",
  • "text": "Hello from Red Cloud",
  • "externalReference": "order_789"
}

Response samples

Content type
application/json
Example
{
  • "results": [
    ],
  • "errors": [ ]
}