OORQO API

Quickstart

Create an API token, add a contact and send your first WhatsApp message.

This guide takes about five minutes. You need an ORQO organization with a connected WhatsApp number and an Admin role in it.

Create an API token

In ORQO open Settings → API Tokens (/app/api-tokens) and choose Create token. Creating a token needs two-factor authentication on your account, and the token is shown once: copy it straight into your server's secret store.

export ORQO_API_TOKEN="1|kQ3x…"

A token can do everything an Admin can do through the API. Keep it on your server; never put it in a web page or a mobile app.

Check the token

curl https://app.orqo.site/api/v1/me \
  -H "Authorization: Bearer $ORQO_API_TOKEN"
200 OK
{
  "data": {
    "id": 7,
    "name": "Mona Adel",
    "email": "mona@example.com",
    "role": "client",
    "status": "active",
    "email_verified_at": "2026-09-01T10:00:00Z",
    "created_at": "2026-09-01T09:58:12Z"
  }
}

A 401 with "code": "unauthenticated" means the token is wrong, revoked or expired.

Add a contact

curl https://app.orqo.site/api/v1/contacts \
  -H "Authorization: Bearer $ORQO_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: contact-rahim-0001" \
  -d '{"phone_e164": "+201001234567", "first_name": "Rahim", "opt_in_whatsapp": true}'

The response is 201 Created with the contact in data (or 200 if a contact with that number already existed: it is updated instead). Keep its id.

Send a WhatsApp message

A free-form text works while the customer's 24-hour service window is open. Outside it, send an approved template (Send a message).

curl https://app.orqo.site/api/v1/messages \
  -H "Authorization: Bearer $ORQO_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-1042-shipped" \
  -d '{"contact_id": 42, "type": "text", "body": "Your order has shipped 🚚"}'
201 Created
{
  "data": {
    "id": 901,
    "provider_message_id": "wamid.HBgM…",
    "status": "sent",
    "type": "text",
    "contact_id": 42,
    "conversation_id": 18,
    "conversation_uuid": "9b1f…",
    "channel_account_id": 3,
    "to": "+201001234567",
    "sent_at": "2026-10-22T09:30:00Z"
  }
}

The message appears in the ORQO inbox in the contact's conversation, and replies come back there.

What's next?

On this page