API

An access token and a phone number ID is the whole setup.

API enabled

Access token

Workspace secret — keep it server-side.

om_live_9f2c••••••••••••••••c6a1

Phone number IDs

  • Probfly IT
    +1 415 555 0123
    108234556789012
  • Probfly BD
    +880 1712 345678
    417702938455120
  • Probfly UK
    +44 20 7946 0958
    902113845567321

Authentication

As a parameter, or as a bearer header.

As a parameter

https://app.omnistra.ai/api/v1/contact?apiToken=om_live_9f2c••••••••••••••••c6a1

As a header

curl 'https://app.omnistra.ai/api/v1/contact' \
  -H 'Authorization: Bearer om_live_9f2c••••••••••••••••c6a1'
  • •HTTPS only.
  • •Bodies accept form-urlencoded or json.
  • •Over the limit: 429 with Retry-After.

Responses & errors

Every endpoint uses the same envelope.

Success

{
  "status": "1",
  "data": { },
  "message": "Contact created successfully."
}

Failure

{
  "status": "0",
  "message": "A contact with this phone number already exists."
}
  • 200
    OK
    Request succeeded. The body always carries status: "1".
  • 401
    Unauthorized
    Missing, malformed or regenerated access token.
  • 403
    Forbidden
    Your plan does not include API access.
  • 404
    Not Found
    Contact, tag or template does not exist.
  • 422
    Unprocessable
    A required parameter is missing or fails validation.
  • 429
    Too Many Requests
    Retry after the seconds in Retry-After.
  • 500
    Server Error
    Our side. Safe to retry with backoff.
  • •Tag add and remove are idempotent. Contact create is not.
  • •Retry 429 and 5xx with backoff. Never other 4xx.