Skip to main content
POST
Pre-Flight 21-Rule UCC Compliance & Segmentation Check

Authorizations

Client-ID
string
header
required

Your UgaText Client-ID (e.g. uga_...). Accepted header aliases: X-Client-ID, or combined in Authorization: Bearer : / X-API-Key: :.

Client-Secret
string
header
required

Your UgaText Client-Secret (e.g. sk_live_...). Accepted header alias: X-Client-Secret.

Body

application/json
message
string
required

SMS text body to inspect against 21 UCC compliance rules and GSM-7/UCS-2 segmentation (accepted aliases: "text", "body").

Example:

"Your verification code is 482910."

sender_id
string

Alphanumeric Sender ID to evaluate (accepted alias: "senderId").

Example:

"UGATEXT"

Response

200 - application/json

Compliance analysis result

success
boolean
Example:

true

decision
enum<string>
Available options:
APPROVE,
WARN,
BLOCK
Example:

"APPROVE"

risk_score
number
Example:

0

character_count
integer
Example:

33

encoding
enum<string>
Available options:
GSM-7,
UCS-2
Example:

"GSM-7"

sms_parts
integer
Example:

1

cost_estimate_ugx
number
Example:

25

violations
string[]
warnings
string[]
inspected_at
string<date-time>