curl --request POST \
--url https://api.revring.ai/v1/messages \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"to": "+14155551234",
"messagingConnectionId": "mc_123abc",
"body": "Your booking is confirmed for 2:00 PM."
}
'{
"data": {
"id": "<string>",
"agentId": "<string>",
"agentName": "<string>",
"messagingConnectionId": "<string>",
"callId": "<string>",
"conversationId": "<string>",
"direction": "INBOUND",
"channel": "sms",
"fromNumber": "<string>",
"toNumber": "<string>",
"body": "<string>",
"status": "<string>",
"providerMessageId": "<string>",
"generatedByLlm": true,
"errorMessage": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
}{
"error": "invalid_body"
}{
"error": "unauthorized"
}{
"error": "billing_inactive"
}{
"error": "agent_not_found"
}{
"error": "generation_failed"
}Send Message
Send an SMS. Provide either a raw body or set generate to true to compose the message with AI from the agent’s SMS prompt and optional inline history. Sends through your connected provider.
curl --request POST \
--url https://api.revring.ai/v1/messages \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"to": "+14155551234",
"messagingConnectionId": "mc_123abc",
"body": "Your booking is confirmed for 2:00 PM."
}
'{
"data": {
"id": "<string>",
"agentId": "<string>",
"agentName": "<string>",
"messagingConnectionId": "<string>",
"callId": "<string>",
"conversationId": "<string>",
"direction": "INBOUND",
"channel": "sms",
"fromNumber": "<string>",
"toNumber": "<string>",
"body": "<string>",
"status": "<string>",
"providerMessageId": "<string>",
"generatedByLlm": true,
"errorMessage": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
}{
"error": "invalid_body"
}{
"error": "unauthorized"
}{
"error": "billing_inactive"
}{
"error": "agent_not_found"
}{
"error": "generation_failed"
}Authorizations
API key for authentication. Generate API keys from the RevRing dashboard. A key is either full access or read-only; a read-only key is refused with 403 read_only_key on any request that creates, changes or deletes.
Body
Send a text. Provide exactly one of body (raw) or generate: true (AI-composed).
Recipient phone number in E.164, e.g. +12025550123
Optional sender number in E.164. Defaults to the agent's send-from number, or the connection's Messaging Service.
Agent to attribute the message to. For generation, its SMS prompt and connection are used.
Connection to send through. Required if no agentId is given or the agent has no connection.
Raw message text. Use this OR generate.
1 - 1600If true, compose the message with AI from the SMS prompt and optional messages history.
Optional inline conversation history for generation (stateless; you own the memory).
Show child attributes
Show child attributes
Optional prompt override for generation. Defaults to the agent's SMS prompt.
Response
Message accepted and sent
A logged text message (sent or received).
Show child attributes
Show child attributes