> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ugatext.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API reference overview

> Base URL, request format, and message fields for the UgaText REST API.

```text Base URL theme={null}
https://ugatext.com/api/v1
```

All requests use HTTPS and JSON. Authenticate with your `Client-ID` and `Client-Secret` headers. See [Authentication](https://docs.ugatext.com/authentication.md).

## Phone number formats

The `to` field accepts E.164 with or without a leading `+` (`+256750625684`, `256750625684`) or local format (`0750625684`).

## Field aliases

| Field | Accepted aliases |
| - | - |
| `to` | `phone`, `recipient`, first item of `recipients[]` or `phones[]` |
| `message` | `text`, `body` |
| `sender_id` | `senderId`, `from` |
| `recipients` (bulk) | `phones`, `to`, `messages` |

## Message lifecycle

Messages start as `queued`, then move to `sent` and `delivered`, or `failed`. Poll `GET /sms/status/{id}` or use [webhooks](https://docs.ugatext.com/webhooks.md).

## Message encoding

Messages are encoded as `GSM-7` or `UCS-2` (Unicode). The response's `segments` field shows how many SMS units the message uses.

## Bulk limits

`POST /sms/bulk` accepts up to 5,000 recipients per request.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.