Guides

Quickstart

Follow these steps to send your first message through the API — from getting your key to reading the response.

Before you start

You need a Workspace and an API key. If you don't have one yet, see Accessing your API key.

Step 1: Get your API key

Every request is authorized with an API key tied to your Workspace. Copy yours from Account Configuration > API Key — see Accessing your API key for the exact steps.

Step 2: Authenticate your request

Send the key as a Bearer token in the Authorization header of every request:

Authorization: Bearer YOUR_API_KEY

Step 3: Send your first message

Send a test message either from the platform UI or directly through the API — pick whichever matches how you'll actually integrate.

Option A: From the Communications Platform UI

  1. Go to New Broadcast/Automation and select SMS.
  2. Follow the SMS broadcast steps, using a list with just your own test number as the recipient.
  3. Send it and check the delivery status in Reporting.

Option B: From the API

This example uses a reserved test number (+12125550143, NANP 555-01XX range) so it's safe to copy and run as-is.

curl --request POST \
  --url https://elastic.messangi.me/raven/v3/messages \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "from": "12345",
    "to": "+12125550143",
    "text": "Hello from Coffee Shop!",
    "type": "MT"
  }'

Option C: Try it from the API Reference, no code required

Open Send SMS message (in the Outbound SMS section of the Reference) and use the Try It panel — enter your API key once, fill in the same fields shown above, and send a real test request right from the browser.

Step 4: Read the response

A successful request returns 202 Accepted with the message record:

{
  "meta": {
    "timestamp": 1597166699457,
    "transactionId": "70169d77-c165-4795-9932-35b8a3af96fb"
  },
  "data": {
    "id": "1",
    "from": "12345",
    "to": "+12125550143",
    "text": "Hello from Coffee Shop!",
    "status": "SENT",
    "date": "2020-06-22T15:06:37.909584Z"
  }
}

status moves from SENT to a final delivery status as the carrier processes the message.

What's next

Updated 2 days ago