API Reference Index

Cross-cutting reference for all external API integrations. For per-method documentation (parameters, request/response shapes, cURL examples), see the OmnixGatewayRpc generated reference.

Base URL

https://your-omnix-instance.com/api/rpc

All requests go to this single endpoint. The method is specified in the JSON body.

Request Format

Every call is an HTTP POST with a JSON body:

{
  "method": "OmnixGatewayRpc.methodName",
  "params": {
    "...": "..."
  }
}

Required headers:

Response Format

Success:

{
  "result": { ... }
}

Failure:

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable description.",
    "details": { ... }
  }
}

The top-level HTTP status code also reflects success (2xx) or failure (4xx/5xx).

Authentication

API keys are passed in the x-api-key header. See Authentication for key generation and security guidance.

Rate Limits

Rate-limited responses return HTTP 429 with a Retry-After header. See Error Handling for the recommended retry strategy.

Pagination

Methods that return lists (e.g., listAssignedExtensions, getAvailableExtensions) accept page and pageSize parameters:

{
  "method": "OmnixGatewayRpc.listAssignedExtensions",
  "params": {
    "page": 1,
    "pageSize": 50
  }
}

Responses include:

{
  "items": [...],
  "total": 142,
  "page": 1,
  "pageSize": 50,
  "hasMore": true
}

Default pageSize is 50. Maximum is 200.

Idempotency

The findOrCreateContact method is inherently idempotent — calling it multiple times with the same contact identifiers will match the existing contact rather than creating duplicates.

For message-sending methods (sendTemplatedMessage, sendSystemMessage), each call produces a new message. Implement deduplication in your own application if needed.

Supported Channel Types

The channelType parameter accepts the following string values:

See Channels for constraints and setup requirements per channel.

Generated Endpoint Reference