Channels
Channels — 6 operations (POST /v1/apps/{appId}/messenger-links, GET /v1/apps/{appId}/channels, GET /v1/apps/{appId}/channels/status, …). Generated from the OpenAPI 3.1.0 contract.
APNs, FCM, HMS, Web Push, email and SMS channel configuration; secret fields are stored encrypted and never returned in responses. validate runs a real connection test against the provider.
Base URL: https://api.pushizo.com · Tag: channels · Interactive docs (Scalar)
Operations
| Method | Path | Operation |
|---|---|---|
POST | /v1/apps/{appId}/messenger-links | Telegram/Viber subscription deep link (single-use token; when the user messages the bot, the chat ID is linked to this user as a subscription) |
GET | /v1/apps/{appId}/channels | Channel configurations |
GET | /v1/apps/{appId}/channels/status | Channel summary (provider and status only; no configuration details are returned) |
POST | /v1/apps/{appId}/channels/email/verify-dns | SPF/DKIM/DMARC verification of the sender domain |
PUT | /v1/apps/{appId}/channels/{channel} | Upload credentials (APNs p8, FCM service account, VAPID, mock) |
POST | /v1/apps/{appId}/channels/{channel}/validate | Test connection to the provider |
Details
Telegram/Viber subscription deep link (single-use token; when the user messages the bot, the chat ID is linked to this user as a subscription)
Authentication: API key — scope users:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: CreateMessengerLinkDto
| Field | Type | Required | Description |
|---|---|---|---|
channel | enum | Yes | Values: "telegram", "viber" |
user_id | string | No | Length: 1–64 |
external_id | string | No | Length: 1–255 |
ttl_seconds | integer | No | Range: 60–2592000 |
Example:
{
"channel": "telegram",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"ttl_seconds": 60
}Responses
201 — Success.
Schema: MessengerLink
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
channel | enum | Yes | Values: "telegram", "viber" |
user_id | string | Yes | |
url | string | Yes | |
token | string | Yes | |
expires_at | string | Yes |
Example response:
{
"url": "https://pushizo.com/orders/1001",
"channel": "telegram",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token": "d1f2e3…",
"expires_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/messenger-links" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"channel": "telegram",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"ttl_seconds": 60
}'Channel configurations
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: ChannelList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
data[].provider | enum | null | Yes | |
data[].status | enum | Yes | Values: "unconfigured", "active", "invalid", "suspended" |
data[].config | object | Yes | |
data[].config.auth_type | enum | No | Values: "token", "certificate" |
data[].config.certificate_environment | enum | No | Values: "sandbox", "production", "universal" |
data[].config.certificate_subject | string | No | |
data[].config.certificate_expires_at | string | No | |
data[].config.key_id | string | No | |
data[].config.team_id | string | No | |
data[].config.bundle_id | string | No | |
data[].config.environment | enum | No | Values: "sandbox", "production" |
data[].config.project_id | string | No | |
data[].config.client_email | string | No | |
data[].config.hms_app_id | string | No | |
data[].config.high_priority | boolean | No | |
data[].config.subject | string | No | |
data[].config.vapid_public_key | string | No | |
data[].config.site_url | string | No | |
data[].config.from_address | string | No | |
data[].config.from_name | string | No | |
data[].config.reply_to | string | No | |
data[].config.dkim_selector | string | No | |
data[].config.postal_address | string | No | |
data[].config.host | string | No | |
data[].config.port | integer | No | |
data[].config.secure | boolean | No | |
data[].config.username | string | No | |
data[].config.region | string | No | |
data[].config.access_key_id | string | No | |
data[].config.configuration_set | string | No | |
data[].config.account_sid | string | No | |
data[].config.from_number | string | No | |
data[].config.messaging_service_sid | string | No | |
data[].config.verify_service_sid | string | No | |
data[].config.usercode | string | No | |
data[].config.msgheader | string | No | |
data[].config.iys_filter | enum | No | Values: "0", "11", "12" |
data[].config.waba_id | string | No | |
data[].config.phone_number_id | string | No | |
data[].config.graph_api_version | string | No | |
data[].config.display_phone_number | string | No | |
data[].config.verified_name | string | No | |
data[].config.rbm_agent_id | string | No | |
data[].config.content_sid | string | No | |
data[].config.sms_fallback | boolean | No | |
data[].config.telegram_bot_username | string | No | |
data[].config.viber_uri | string | No | |
data[].config.viber_sender_name | string | No | |
data[].config.viber_sender_avatar | string | No | |
data[].config.webhook_registered_at | string | No | |
data[].has_secret | boolean | Yes | |
data[].has_hook | boolean | Yes | |
data[].last_validated_at | string | null | Yes | |
data[].last_error | string | null | Yes | |
data[].updated_at | string | null | Yes | |
data[].suspended_reason | string | null | Yes | |
data[].dns_check | object | null | Yes |
Example response:
{
"data": [
{
"channel": "ios_push",
"status": "unconfigured",
"provider": "apns",
"config": {
"auth_type": "token",
"certificate_environment": "sandbox"
},
"has_secret": true,
"has_hook": true,
"last_validated_at": "örnek",
"last_error": "örnek",
"updated_at": "örnek",
"suspended_reason": "örnek",
"dns_check": {
"domain": "örnek",
"checked_at": "örnek",
"spf": {
"ok": true,
"record": "örnek",
"expected": "örnek"
},
"dkim": {
"ok": true,
"selector": "örnek",
"record": "örnek",
"expected": "örnek"
},
"dmarc": {
"ok": true,
"record": "örnek",
"expected": "örnek"
},
"issues": [
"örnek"
]
}
}
]
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/channels" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Channel summary (provider and status only; no configuration details are returned)
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: ChannelStatusList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].channel | string | Yes | |
data[].provider | string | null | Yes | |
data[].status | string | Yes |
Example response:
{
"data": [
{
"channel": "web_push",
"status": "örnek",
"provider": "örnek"
}
]
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/channels/status" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"SPF/DKIM/DMARC verification of the sender domain
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
| Field | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | |
checked_at | string | Yes | |
spf | object | Yes | |
spf.ok | boolean | Yes | |
spf.record | string | null | Yes | |
spf.expected | string | Yes | |
dkim | object | Yes | |
dkim.ok | boolean | Yes | |
dkim.selector | string | Yes | |
dkim.record | string | null | Yes | |
dkim.expected | string | Yes | |
dmarc | object | Yes | |
dmarc.ok | boolean | Yes | |
dmarc.record | string | null | Yes | |
dmarc.expected | string | Yes | |
issues | array<string> | Yes |
Example response:
{
"domain": "örnek",
"checked_at": "örnek",
"spf": {
"ok": true,
"record": "örnek",
"expected": "örnek"
},
"dkim": {
"ok": true,
"selector": "örnek",
"record": "örnek",
"expected": "örnek"
},
"dmarc": {
"ok": true,
"record": "örnek",
"expected": "örnek"
},
"issues": [
"örnek"
]
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/channels/email/verify-dns" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Upload credentials (APNs p8, FCM service account, VAPID, mock)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
channel | path | string | Yes | "web_push" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Type: object
Example:
{
"provider": "apns",
"key_id": "key_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"team_id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"bundle_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_clip_bundle_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"environment": "sandbox"
}Responses
200 — Success.
Schema: ChannelConfig
| Field | Type | Required | Description |
|---|---|---|---|
channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
provider | enum | null | Yes | |
status | enum | Yes | Values: "unconfigured", "active", "invalid", "suspended" |
config | object | Yes | |
config.auth_type | enum | No | Values: "token", "certificate" |
config.certificate_environment | enum | No | Values: "sandbox", "production", "universal" |
config.certificate_subject | string | No | |
config.certificate_expires_at | string | No | |
config.key_id | string | No | |
config.team_id | string | No | |
config.bundle_id | string | No | |
config.environment | enum | No | Values: "sandbox", "production" |
config.project_id | string | No | |
config.client_email | string | No | |
config.hms_app_id | string | No | |
config.high_priority | boolean | No | |
config.subject | string | No | |
config.vapid_public_key | string | No | |
config.site_url | string | No | |
config.from_address | string | No | |
config.from_name | string | No | |
config.reply_to | string | No | |
config.dkim_selector | string | No | |
config.postal_address | string | No | |
config.host | string | No | |
config.port | integer | No | |
config.secure | boolean | No | |
config.username | string | No | |
config.region | string | No | |
config.access_key_id | string | No | |
config.configuration_set | string | No | |
config.account_sid | string | No | |
config.from_number | string | No | |
config.messaging_service_sid | string | No | |
config.verify_service_sid | string | No | |
config.usercode | string | No | |
config.msgheader | string | No | |
config.iys_filter | enum | No | Values: "0", "11", "12" |
config.waba_id | string | No | |
config.phone_number_id | string | No | |
config.graph_api_version | string | No | |
config.display_phone_number | string | No | |
config.verified_name | string | No | |
config.rbm_agent_id | string | No | |
config.content_sid | string | No | |
config.sms_fallback | boolean | No | |
config.telegram_bot_username | string | No | |
config.viber_uri | string | No | |
config.viber_sender_name | string | No | |
config.viber_sender_avatar | string | No | |
config.webhook_registered_at | string | No | |
has_secret | boolean | Yes | |
has_hook | boolean | Yes | |
last_validated_at | string | null | Yes | |
last_error | string | null | Yes | |
updated_at | string | null | Yes | |
suspended_reason | string | null | Yes | |
dns_check | object | null | Yes |
Example response:
{
"channel": "ios_push",
"status": "unconfigured",
"provider": "apns",
"config": {
"auth_type": "token",
"certificate_environment": "sandbox",
"certificate_subject": "örnek",
"certificate_expires_at": "örnek"
},
"has_secret": true,
"has_hook": true,
"last_validated_at": "örnek",
"last_error": "örnek",
"updated_at": "örnek",
"suspended_reason": "örnek",
"dns_check": {
"domain": "örnek",
"checked_at": "örnek",
"spf": {
"ok": true,
"record": "örnek",
"expected": "örnek"
},
"dkim": {
"ok": true,
"selector": "örnek",
"record": "örnek",
"expected": "örnek"
},
"dmarc": {
"ok": true,
"record": "örnek",
"expected": "örnek"
},
"issues": [
"örnek"
]
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X PUT "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/channels/web_push" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"provider": "apns",
"key_id": "key_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"team_id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"bundle_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_clip_bundle_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"environment": "sandbox"
}'Test connection to the provider
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
channel | path | string | Yes | "web_push" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: ChannelValidation
| Field | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | |
kind | enum | null | Yes | |
code | string | null | Yes | |
message | string | null | Yes | |
details | map<string, any> | null | Yes | |
channel | object | Yes | |
channel.channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
channel.provider | enum | null | Yes | |
channel.status | enum | Yes | Values: "unconfigured", "active", "invalid", "suspended" |
channel.config | object | Yes | |
channel.config.auth_type | enum | No | Values: "token", "certificate" |
channel.config.certificate_environment | enum | No | Values: "sandbox", "production", "universal" |
channel.config.certificate_subject | string | No | |
channel.config.certificate_expires_at | string | No | |
channel.config.key_id | string | No | |
channel.config.team_id | string | No | |
channel.config.bundle_id | string | No | |
channel.config.environment | enum | No | Values: "sandbox", "production" |
channel.config.project_id | string | No | |
channel.config.client_email | string | No | |
channel.config.hms_app_id | string | No | |
channel.config.high_priority | boolean | No | |
channel.config.subject | string | No | |
channel.config.vapid_public_key | string | No | |
channel.config.site_url | string | No | |
channel.config.from_address | string | No | |
channel.config.from_name | string | No | |
channel.config.reply_to | string | No | |
channel.config.dkim_selector | string | No | |
channel.config.postal_address | string | No | |
channel.config.host | string | No | |
channel.config.port | integer | No | |
channel.config.secure | boolean | No | |
channel.config.username | string | No | |
channel.config.region | string | No | |
channel.config.access_key_id | string | No | |
channel.config.configuration_set | string | No | |
channel.config.account_sid | string | No | |
channel.config.from_number | string | No | |
channel.config.messaging_service_sid | string | No | |
channel.config.verify_service_sid | string | No | |
channel.config.usercode | string | No | |
channel.config.msgheader | string | No | |
channel.config.iys_filter | enum | No | Values: "0", "11", "12" |
channel.config.waba_id | string | No | |
channel.config.phone_number_id | string | No | |
channel.config.graph_api_version | string | No | |
channel.config.display_phone_number | string | No | |
channel.config.verified_name | string | No | |
channel.config.rbm_agent_id | string | No | |
channel.config.content_sid | string | No | |
channel.config.sms_fallback | boolean | No | |
channel.config.telegram_bot_username | string | No | |
channel.config.viber_uri | string | No | |
channel.config.viber_sender_name | string | No | |
channel.config.viber_sender_avatar | string | No | |
channel.config.webhook_registered_at | string | No | |
channel.has_secret | boolean | Yes | |
channel.has_hook | boolean | Yes | |
channel.last_validated_at | string | null | Yes | |
channel.last_error | string | null | Yes | |
channel.updated_at | string | null | Yes | |
channel.suspended_reason | string | null | Yes | |
channel.dns_check | object | null | Yes |
Example response:
{
"channel": {
"channel": "ios_push",
"status": "unconfigured",
"provider": "apns",
"config": {
"auth_type": "token",
"certificate_environment": "sandbox"
},
"has_secret": true,
"has_hook": true,
"last_validated_at": "örnek",
"last_error": "örnek",
"updated_at": "örnek",
"suspended_reason": "örnek",
"dns_check": {
"domain": "örnek",
"checked_at": "örnek",
"spf": {
"ok": true,
"record": "örnek",
"expected": "örnek"
},
"dkim": {
"ok": true,
"selector": "örnek",
"record": "örnek",
"expected": "örnek"
},
"dmarc": {
"ok": true,
"record": "örnek",
"expected": "örnek"
},
"issues": [
"örnek"
]
}
},
"ok": true,
"kind": "auth",
"code": "örnek",
"message": "Takip bağlantısı içeride",
"details": {
"key": "örnek"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/channels/web_push/validate" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Identity verification keys
Identity verification keys — 3 operations (GET /v1/apps/{appId}/identity-keys, POST /v1/apps/{appId}/identity-keys, DELETE /v1/apps/{appId}/identity-keys/{keyId}). Generated from the OpenAPI 3.1.0 contract.
Notifications
Notifications — 9 operations (GET /v1/notifications, POST /v1/notifications, POST /v1/notifications/estimate, …). Generated from the OpenAPI 3.1.0 contract.