Incoming Routes
GET /api/organizations/{tenant_id}/incoming-routes/greeting-templates
Get Greeting Templates
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| tenant_id | Tenant Id |
Response 200: Successful Response
array[GreetingTemplateResponse]
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| id | Id | нет | |
| code | Code | нет | |
| language | Language | нет | |
| text | Text | нет | |
| audio_file | Audio File | нет | |
| created_at | Created At | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
POST /api/organizations/{tenant_id}/incoming-routes/tts-preview
Preview Tts
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| tenant_id | Tenant Id |
Request Body:
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| text | Text | да | Текст для озвучивания |
| language | Language | нет | Язык: kz или ru |
Response 200: Successful Response
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| success | Success | нет | |
| message | Message | нет | |
| audio_url | Audio Url | нет | |
| audio_data | Audio Data | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
GET /api/organizations/{tenant_id}/incoming-routes/tts-audio/{cache_key}
Get Tts Audio
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| tenant_id | Tenant Id | |
| cache_key | Cache Key |
Response 200: Successful Response
Нет данных
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
POST /api/organizations/{tenant_id}/incoming-routes/greeting-preview
Preview Greeting
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| tenant_id | Tenant Id |
Request Body:
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| blocks | array[object] | да | Блоки приветствия |
| greeting_language | Greeting Language | нет | Язык приветствия: kz, ru, both |
| recording_notice_enabled | Recording Notice Enabled | нет | Добавить уведомление о записи |
Response 200: Successful Response
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| success | Success | нет | |
| message | Message | нет | |
| audio_url | Audio Url | нет | |
| audio_data | Audio Data | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
GET /api/organizations/{tenant_id}/incoming-routes/
Get Incoming Routes
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| tenant_id | Tenant Id |
Query параметры:
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
| skip | Skip | 0 | |
| limit | Limit | 100 | |
| include_inactive | Include Inactive | False |
Response 200: Successful Response
array[IncomingRouteResponse]
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| did | Did | нет | DID номер |
| destination_type | Destination Type | нет | Тип назначения: queue, ivr, extension, voicemail |
| destination_value | Destination Value | нет | Значение назначения |
| is_active | Is Active | нет | Активен ли маршрут |
| org_name_kz | Org Name Kz | нет | Название организации (казахский) |
| org_name_ru | Org Name Ru | нет | Название организации (русский) |
| personal_data_enabled | Personal Data Enabled | нет | Согласие на персональные данные |
| play_greeting | Play Greeting | нет | Проигрывать приветствие |
| greeting_language | Greeting Language | нет | Язык приветствия: kz, ru, both |
| greeting_text | Greeting Text | нет | Текст приветствия (русский) |
| greeting_text_kz | Greeting Text Kz | нет | Текст приветствия (казахский) |
| recording_notice_enabled | Recording Notice Enabled | нет | Уведомление о записи разговора |
| id | Id | нет | |
| tenant_id | Tenant Id | нет | |
| greeting_file | Greeting File | нет | |
| created_at | Created At | нет | |
| greeting_blocks | array[object] | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
POST /api/organizations/{tenant_id}/incoming-routes/
Create Incoming Route
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| tenant_id | Tenant Id |
Request Body:
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| did | Did | да | DID номер |
| destination_type | Destination Type | да | Тип назначения: queue, ivr, extension, voicemail |
| destination_value | Destination Value | да | Значение назначения |
| is_active | Is Active | нет | Активен ли маршрут |
| org_name_kz | Org Name Kz | нет | Название организации (казахский) |
| org_name_ru | Org Name Ru | нет | Название организации (русский) |
| personal_data_enabled | Personal Data Enabled | нет | Согласие на персональные данные |
| play_greeting | Play Greeting | нет | Проигрывать приветствие |
| greeting_language | Greeting Language | нет | Язык приветствия: kz, ru, both |
| greeting_text | Greeting Text | нет | Текст приветствия (русский) |
| greeting_text_kz | Greeting Text Kz | нет | Текст приветствия (казахский) |
| recording_notice_enabled | Recording Notice Enabled | нет | Уведомление о записи разговора |
| greeting_blocks | Greeting Blocks | нет | Блоки приветствия (только для extension) |
Response 201: Successful Response
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| did | Did | нет | DID номер |
| destination_type | Destination Type | нет | Тип назначения: queue, ivr, extension, voicemail |
| destination_value | Destination Value | нет | Значение назначения |
| is_active | Is Active | нет | Активен ли маршрут |
| org_name_kz | Org Name Kz | нет | Название организации (казахский) |
| org_name_ru | Org Name Ru | нет | Название организации (русский) |
| personal_data_enabled | Personal Data Enabled | нет | Согласие на персональные данные |
| play_greeting | Play Greeting | нет | Проигрывать приветствие |
| greeting_language | Greeting Language | нет | Язык приветствия: kz, ru, both |
| greeting_text | Greeting Text | нет | Текст приветствия (русский) |
| greeting_text_kz | Greeting Text Kz | нет | Текст приветствия (казахский) |
| recording_notice_enabled | Recording Notice Enabled | нет | Уведомление о записи разговора |
| id | Id | нет | |
| tenant_id | Tenant Id | нет | |
| greeting_file | Greeting File | нет | |
| created_at | Created At | нет | |
| greeting_blocks | array[object] | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
GET /api/organizations/{tenant_id}/incoming-routes/{route_id}
Get Incoming Route
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| tenant_id | Tenant Id | |
| route_id | Route Id |
Response 200: Successful Response
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| did | Did | нет | DID номер |
| destination_type | Destination Type | нет | Тип назначения: queue, ivr, extension, voicemail |
| destination_value | Destination Value | нет | Значение назначения |
| is_active | Is Active | нет | Активен ли маршрут |
| org_name_kz | Org Name Kz | нет | Название организации (казахский) |
| org_name_ru | Org Name Ru | нет | Название организации (русский) |
| personal_data_enabled | Personal Data Enabled | нет | Согласие на персональные данные |
| play_greeting | Play Greeting | нет | Проигрывать приветствие |
| greeting_language | Greeting Language | нет | Язык приветствия: kz, ru, both |
| greeting_text | Greeting Text | нет | Текст приветствия (русский) |
| greeting_text_kz | Greeting Text Kz | нет | Текст приветствия (казахский) |
| recording_notice_enabled | Recording Notice Enabled | нет | Уведомление о записи разговора |
| id | Id | нет | |
| tenant_id | Tenant Id | нет | |
| greeting_file | Greeting File | нет | |
| created_at | Created At | нет | |
| greeting_blocks | array[object] | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
PUT /api/organizations/{tenant_id}/incoming-routes/{route_id}
Update Incoming Route
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| tenant_id | Tenant Id | |
| route_id | Route Id |
Request Body:
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| did | Did | нет | DID номер |
| destination_type | Destination Type | нет | |
| destination_value | Destination Value | нет | |
| is_active | Is Active | нет | |
| greeting_blocks | Greeting Blocks | нет | Блоки приветствия (deprecated для extension) |
| org_name_kz | Org Name Kz | нет | Название организации (казахский) |
| org_name_ru | Org Name Ru | нет | Название организации (русский) |
| personal_data_enabled | Personal Data Enabled | нет | Согласие на персональные данные |
| play_greeting | Play Greeting | нет | Проигрывать приветствие |
| greeting_language | Greeting Language | нет | Язык приветствия: kz, ru, both |
| greeting_text | Greeting Text | нет | Текст приветствия (русский) |
| greeting_text_kz | Greeting Text Kz | нет | Текст приветствия (казахский) |
| recording_notice_enabled | Recording Notice Enabled | нет | Уведомление о записи разговора |
Response 200: Successful Response
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| did | Did | нет | DID номер |
| destination_type | Destination Type | нет | Тип назначения: queue, ivr, extension, voicemail |
| destination_value | Destination Value | нет | Значение назначения |
| is_active | Is Active | нет | Активен ли маршрут |
| org_name_kz | Org Name Kz | нет | Название организации (казахский) |
| org_name_ru | Org Name Ru | нет | Название организации (русский) |
| personal_data_enabled | Personal Data Enabled | нет | Согласие на персональные данные |
| play_greeting | Play Greeting | нет | Проигрывать приветствие |
| greeting_language | Greeting Language | нет | Язык приветствия: kz, ru, both |
| greeting_text | Greeting Text | нет | Текст приветствия (русский) |
| greeting_text_kz | Greeting Text Kz | нет | Текст приветствия (казахский) |
| recording_notice_enabled | Recording Notice Enabled | нет | Уведомление о записи разговора |
| id | Id | нет | |
| tenant_id | Tenant Id | нет | |
| greeting_file | Greeting File | нет | |
| created_at | Created At | нет | |
| greeting_blocks | array[object] | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
DELETE /api/organizations/{tenant_id}/incoming-routes/{route_id}
Delete Incoming Route
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| tenant_id | Tenant Id | |
| route_id | Route Id |
Response 200: Successful Response
Нет данных
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |