did
GET /api/did/trunks
List Trunks
Авторизация: Bearer Token
Response 200: Successful Response
array[DIDTrunkResponse]
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| id | Id | нет | |
| name | Name | нет | |
| description | Description | нет | |
| provider | Provider | нет | |
| is_active | Is Active | нет | |
| created_at | Created At | нет | |
| updated_at | Updated At | нет | |
| numbers_count | Numbers Count | нет |
POST /api/did/trunks
Create Trunk
Авторизация: Bearer Token
Request Body:
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| name | Name | да | |
| description | Description | нет | |
| provider | Provider | нет | |
| is_active | Is Active | нет |
Response 200: Successful Response
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| id | Id | нет | |
| name | Name | нет | |
| description | Description | нет | |
| provider | Provider | нет | |
| is_active | Is Active | нет | |
| created_at | Created At | нет | |
| updated_at | Updated At | нет | |
| numbers_count | Numbers Count | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
GET /api/did/trunks/available
List Available Trunks
Response 200: Successful Response
array[DIDTrunkAvailable]
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| id | Id | нет | |
| name | Name | нет | |
| numbers_count | Numbers Count | нет |
PUT /api/did/trunks/{trunk_id}
Update Trunk
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| trunk_id | Trunk Id |
Request Body:
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| name | Name | нет | |
| description | Description | нет | |
| provider | Provider | нет | |
| is_active | Is Active | нет |
Response 200: Successful Response
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| id | Id | нет | |
| name | Name | нет | |
| description | Description | нет | |
| provider | Provider | нет | |
| is_active | Is Active | нет | |
| created_at | Created At | нет | |
| updated_at | Updated At | нет | |
| numbers_count | Numbers Count | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
DELETE /api/did/trunks/{trunk_id}
Delete Trunk
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| trunk_id | Trunk Id |
Response 200: Successful Response
Нет данных
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
GET /api/did/numbers
List Numbers
Авторизация: Bearer Token
Query параметры:
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
| trunk_id | Trunk Id | ||
| used | Used | all/free/used | |
| search | Search |
Response 200: Successful Response
array[DIDNumberResponse]
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| id | Id | нет | |
| number | Number | нет | |
| trunk_id | Trunk Id | нет | |
| trunk_name | Trunk Name | нет | |
| description | Description | нет | |
| is_active | Is Active | нет | |
| created_at | Created At | нет | |
| updated_at | Updated At | нет | |
| usage | any | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
POST /api/did/numbers
Create Number
Авторизация: Bearer Token
Request Body:
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| number | Number | да | |
| trunk_id | Trunk Id | нет | |
| description | Description | нет | |
| is_active | Is Active | нет |
Response 200: Successful Response
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| id | Id | нет | |
| number | Number | нет | |
| trunk_id | Trunk Id | нет | |
| trunk_name | Trunk Name | нет | |
| description | Description | нет | |
| is_active | Is Active | нет | |
| created_at | Created At | нет | |
| updated_at | Updated At | нет | |
| usage | any | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
GET /api/did/numbers/available
List Available Numbers
Query параметры:
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
| include_number | Include Number | Включить этот номер даже если занят (для редактирования) | |
| trunk_id | Trunk Id | Фильтр по транку |
Response 200: Successful Response
array[DIDNumberAvailable]
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| id | Id | нет | |
| number | Number | нет | |
| formatted_number | Formatted Number | нет | |
| trunk_id | Trunk Id | нет | |
| trunk_name | Trunk Name | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
PUT /api/did/numbers/{number_id}
Update Number
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| number_id | Number Id |
Request Body:
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| number | Number | нет | |
| trunk_id | Trunk Id | нет | |
| description | Description | нет | |
| is_active | Is Active | нет |
Response 200: Successful Response
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| id | Id | нет | |
| number | Number | нет | |
| trunk_id | Trunk Id | нет | |
| trunk_name | Trunk Name | нет | |
| description | Description | нет | |
| is_active | Is Active | нет | |
| created_at | Created At | нет | |
| updated_at | Updated At | нет | |
| usage | any | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
DELETE /api/did/numbers/{number_id}
Delete Number
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| number_id | Number Id |
Response 200: Successful Response
Нет данных
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
GET /api/did/numbers/{number_id}/usage
Get Number Usage Info
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| number_id | Number Id |
Response 200: Successful Response
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| is_used | Is Used | нет | |
| organization_id | Organization Id | нет | |
| organization_name | Organization Name | нет | |
| destination_type | Destination Type | нет | |
| destination_name | Destination Name | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |