Autional Autional
API Reference GitHub autional.com →

GET /communication/rate-limits

Returns rate limit configurations (maximum sends per minute/hour) for SMS, email, push, and other channels based on the currently configured providers, for client-side traffic control reference before sending. References: ePrivacy Directive 2002/58/EC, CAN-SPAM Act.

Communication Service `bearerAuth` application/json

Request Parameters

NameInTypeRequiredDefaultExampleConstraintsDescription
channel query string No Channel filter: sms/email/push (omit to return all)

Responses

StatusDescriptionSchema
200Query successful, returns rate limit configurations for each channeldto.RateLimitsDetailResponse
400Invalid request parametersdto.SimpleResponse
401Unauthenticated or invalid tokendto.SimpleResponse
403Insufficient permissions to access this resourcedto.SimpleResponse
500Internal server errordto.SimpleResponse

Referenced Schemas

domain.ChannelRateLimitData

FieldTypeRequiredExampleConstraintsDescription
max_per_hour integer No
max_per_min integer No
provider string No
tenant_id string No

dto.RateLimitsDetailResponse

FieldTypeRequiredExampleConstraintsDescription
code integer No
data dto.RateLimitsResponse No
message string No
timestamp string No

dto.RateLimitsResponse

Rate limit configuration for each sending channel of the communication service.

FieldTypeRequiredExampleConstraintsDescription
email domain.ChannelRateLimitData No
push domain.ChannelRateLimitData No
sms domain.ChannelRateLimitData No

dto.SimpleResponse

FieldTypeRequiredExampleConstraintsDescription
code integer No
message string No
timestamp string No