Autional Autional
API Reference GitHub autional.com →

POST /admin/communication/providers

Create a connection configuration for an SMS/email/push provider for the current tenant. Supports major providers such as Alibaba Cloud, Tencent Cloud, AWS SNS/SES, SendGrid, FCM, etc. Configuration content (API keys, etc.) is stored encrypted and automatically masked in responses. References: ePrivacy Directive 2002/58/EC, CAN-SPAM Act.

Communication Service `bearerAuth` application/json

Request Body

Schema: dto.CreateProviderConfigRequest

FieldTypeRequiredExampleConstraintsDescription
channel string Yes sms enum: `sms`, `email`, `push`
config string Yes {"access_key":"..."}
provider string Yes aliyun
priority integer No 10

Responses

StatusDescriptionSchema
201Created successfully, returns configuration details (credentials masked)dto.ProviderConfigDataResponse
400Invalid request parametersdto.SimpleResponse
401Unauthenticated or invalid tokendto.SimpleResponse
403Insufficient permissions to access this resourcedto.SimpleResponse
409A configuration for the same channel and provider already existsdto.SimpleResponse
500Internal server errordto.SimpleResponse

Referenced Schemas

dto.ProviderConfigDataResponse

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

dto.ProviderConfigResponse

FieldTypeRequiredExampleConstraintsDescription
app_id string No
channel string No
config string No
created_at string No
id string No
is_active boolean No
priority integer No
provider string No
tenant_id string No
updated_at string No

dto.SimpleResponse

FieldTypeRequiredExampleConstraintsDescription
code integer No
message string No
timestamp string No