> For the complete documentation index, see [llms.txt](https://support.portsip.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://support.portsip.com/development-portsip/rest-apis/version-22.9/models.md).

# Models

## The id-2 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-2":{"allOf":[{"type":"string"}],"description":"The unique ID of role.\n"}}}}
```

## The email-2 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"email-2":{"allOf":[{"type":"string","maxLength":128,"description":"The email address.\n"}],"description":"The email address of user.\n"}}}}
```

## The created\_at object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"created_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The creation time of user.\n"}}}}
```

## The login\_at object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"login_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The last sign in time of user.\n"}}}}
```

## The logout\_at object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"logout_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The last sign out time of user.\n"}}}}
```

## The id-3 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-3":{"allOf":[{"type":"string"}],"description":"The unique ID of user.\n"}}}}
```

## The maintenance\_expires\_at object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"maintenance_expires_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The maintenance expiry time.\n"}}}}
```

## The license\_usage object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"license_usage":{"allOf":[{"type":"object","required":["base","cc","advanced"],"properties":{"base":{"type":"object","required":["max","allocated","used"],"properties":{"max":{"type":"integer","format":"int32","minimum":0,"description":"Maximum quota for the selected scope."},"allocated":{"type":"integer","format":"int32","minimum":0,"description":"Quota reserved by direct children or assigned users."},"used":{"type":"integer","format":"int32","minimum":0,"description":"Current extension usage calculated from database records."}}},"cc":{"type":"object","required":["max","allocated","used"],"properties":{"max":{"type":"integer","format":"int32","minimum":0,"description":"Maximum quota for the selected scope."},"allocated":{"type":"integer","format":"int32","minimum":0,"description":"Quota reserved by direct children or assigned users."},"used":{"type":"integer","format":"int32","minimum":0,"description":"Current extension usage calculated from database records."}}},"advanced":{"type":"object","required":["max","allocated","used"],"properties":{"max":{"type":"integer","format":"int32","minimum":0,"description":"Maximum quota for the selected scope."},"allocated":{"type":"integer","format":"int32","minimum":0,"description":"Quota reserved by direct children or assigned users."},"used":{"type":"integer","format":"int32","minimum":0,"description":"Current extension usage calculated from database records."}}}}}],"description":"System-level Modular License quota summary calculated from the shared\nauthorization snapshot and current database allocation. `max` is the\nconfirmed License total, `allocated` is the quota reserved by all enabled\nTenants across every Dealer level, and `used` is the actual extension\nassignment count in enabled Tenants. Dealer limits are virtual ceilings and\nare not included in the System allocation. This field is omitted when no\nconfirmed snapshot is available; failure to load it does not fail the\nstatus response.\n"}}}}
```

## The trace\_server\_port object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"trace_server_port":{"allOf":[{"type":"integer","format":"int32","minimum":0,"maximum":65535,"description":"A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535.\nFor TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port\n"}],"description":"The tracer server port.\n"}}}}
```

## The aws object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"aws":{"allOf":[{"type":"object","properties":{"provider":{"type":"string","enum":["aws","azure","deepgram","openai","openai-compatible"],"description":"The AI provider for integration.   \n- `aws`: Use AI integration on AWS.\n- `azure`: Use AI integration on Azure.\n- `deepgram`: Use AI integration on Deepgram.\n- `openai`: Use AI integration on OpenAI.\n- `openai-compatible`: Use AI integration on compatible OpenAI.\n"}}},{"type":"object","properties":{"opts":{"type":"object","properties":{"access_key":{"type":"string","minLength":1,"description":"AWS access key ID used to authenticate with AWS services.\n"},"secret_key":{"type":"string","format":"password","minLength":1,"description":"AWS secret access key used to authenticate with AWS services."},"region":{"type":"string","minLength":1,"description":"AWS region where the AI services and related resources are located.\n"},"bucket_name":{"type":"string","minLength":1,"description":"Name of the Amazon S3 bucket used to store AI-related data.\n"},"locale":{"type":"string","minLength":1,"description":"Locale used by the AI service for language and regional processing.\n"},"lang_code":{"type":"string","minLength":1,"description":"Language code used by AI services for language-specific processing.\n"},"max_speech_to_text_queue":{"type":"integer","minimum":1,"description":"Maximum number of speech-to-text requests that can be queued for processing.\n"},"max_sentiment_requests_per_10s":{"type":"integer","minimum":1,"description":"Maximum number of sentiment analysis requests allowed within a 10-second period.\n"}},"description":"AWS configuration for AI service integration.","required":["access_key","secret_key","region","bucket_name","locale","lang_code","max_speech_to_text_queue","max_sentiment_requests_per_10s"]}}}],"required":["provider","opts"]}}}}
```

## The azure object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"azure":{"allOf":[{"type":"object","properties":{"provider":{"type":"string","enum":["aws","azure","deepgram","openai","openai-compatible"],"description":"The AI provider for integration.   \n- `aws`: Use AI integration on AWS.\n- `azure`: Use AI integration on Azure.\n- `deepgram`: Use AI integration on Deepgram.\n- `openai`: Use AI integration on OpenAI.\n- `openai-compatible`: Use AI integration on compatible OpenAI.\n"}}},{"type":"object","properties":{"opts":{"type":"object","properties":{"account_name":{"type":"string","minLength":1,"description":"Name of the Azure storage account used by the AI services.\n"},"account_key":{"type":"string","format":"password","minLength":1,"description":"Access key used to authenticate with the Azure storage account.\n"},"api_key":{"type":"string","format":"password","minLength":1,"description":"API key used to authenticate with Azure AI services.\n"},"region":{"type":"string","minLength":1,"description":"Azure region where the AI services and related resources are located.\n"},"container_name":{"type":"string","minLength":1,"description":"Name of the Azure Blob Storage container used to store AI-related data.\n"},"locale":{"type":"string","minLength":1,"description":"Locale used by Azure AI services for language and regional processing.\n"},"max_stt_requests_per_10s":{"type":"integer","minimum":1,"description":"Maximum number of speech-to-text requests allowed within a 10-second period.\n"},"max_sentiment_requests_per_minute":{"type":"integer","minimum":1,"description":"Maximum number of sentiment analysis requests allowed within a one-minute period.\n"}},"description":"Schema for Azure AI Engine configuration","required":["account_name","account_key","api_key","region","container_name"]}}}],"required":["provider","opts"]}}}}
```

## The deepgram object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"deepgram":{"allOf":[{"type":"object","properties":{"provider":{"type":"string","enum":["aws","azure","deepgram","openai","openai-compatible"],"description":"The AI provider for integration.   \n- `aws`: Use AI integration on AWS.\n- `azure`: Use AI integration on Azure.\n- `deepgram`: Use AI integration on Deepgram.\n- `openai`: Use AI integration on OpenAI.\n- `openai-compatible`: Use AI integration on compatible OpenAI.\n"}}},{"type":"object","properties":{"opts":{"type":"object","properties":{"api_key":{"type":"string","format":"password","minLength":1,"description":"API key used to authenticate with Deepgram services.\n"},"language":{"type":"string","minLength":1,"description":"Language used for speech-to-text transcription.\n"},"model":{"type":"string","minLength":1,"description":"Deepgram speech-to-text model used for transcription.\n"},"max_speech_to_text_concurrent":{"type":"integer","minimum":1,"description":"Maximum number of speech-to-text requests that can be processed concurrently.\n"},"redaction":{"type":"boolean","default":true,"description":"Whether sensitive information should be redacted from the transcription.\n"},"ssn":{"type":"boolean","default":true,"description":"Whether Social Security numbers should be redacted from the transcription.\n"},"pci":{"type":"boolean","default":true,"description":"Whether payment card information should be redacted from the transcription.\n"},"numbers":{"type":"boolean","default":false,"description":"Whether numbers should be redacted from the transcription.\n"}},"description":"Configuration for integrating Deepgram AI services.","required":["api_key","language","model","max_speech_to_text_concurrent","redaction","ssn","pci","numbers"]}}}],"required":["provider","opts"]}}}}
```

## The openai object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"openai":{"allOf":[{"type":"object","properties":{"provider":{"type":"string","enum":["aws","azure","deepgram","openai","openai-compatible"],"description":"The AI provider for integration.   \n- `aws`: Use AI integration on AWS.\n- `azure`: Use AI integration on Azure.\n- `deepgram`: Use AI integration on Deepgram.\n- `openai`: Use AI integration on OpenAI.\n- `openai-compatible`: Use AI integration on compatible OpenAI.\n"}}},{"type":"object","properties":{"opts":{"type":"object","properties":{"analyze_model":{"type":"string","minLength":1,"description":"OpenAI model used for analyzing transcripts or other AI-generated content.\n"},"api_key":{"type":"string","format":"password","minLength":1,"description":"API key used to authenticate with OpenAI services.\n"},"language":{"type":"string","minLength":1,"description":"Language used for speech-to-text transcription and AI processing.\n"},"max_speech_to_text_concurrent":{"type":"string","minimum":1,"description":"Maximum number of speech-to-text requests that can be processed concurrently.\n"},"transcript_model":{"type":"string","minimum":1,"description":"OpenAI model used for generating speech-to-text transcripts.\n"}},"description":"Configuration for integrating OpenAI AI services.","required":["analyze_model","api_key","language","max_speech_to_text_concurrent","transcript_model"]}}}],"required":["provider","opts"]}}}}
```

## The openai\_compatible object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"openai_compatible":{"allOf":[{"type":"object","properties":{"provider":{"type":"string","enum":["aws","azure","deepgram","openai","openai-compatible"],"description":"The AI provider for integration.   \n- `aws`: Use AI integration on AWS.\n- `azure`: Use AI integration on Azure.\n- `deepgram`: Use AI integration on Deepgram.\n- `openai`: Use AI integration on OpenAI.\n- `openai-compatible`: Use AI integration on compatible OpenAI.\n"}}},{"type":"object","properties":{"opts":{"type":"object","properties":{"base_url":{"type":"string","format":"uri","minLength":1,"description":"OpenAI compatible service base URL.\n"},"analyze_model":{"type":"string","minLength":1,"description":"OpenAI compatible model used for analyzing transcripts or other AI-generated content.\n"},"api_key":{"type":"string","format":"password","minLength":1,"description":"API key used to authenticate with OpenAI compatible services.\n"},"language":{"type":"string","minLength":1,"description":"Language used for speech-to-text transcription and AI processing.\n"},"max_speech_to_text_concurrent":{"type":"string","minimum":1,"description":"Maximum number of speech-to-text requests that can be processed concurrently.\n"},"transcript_model":{"type":"string","minimum":1,"description":"OpenAI model used for generating speech-to-text transcripts.\n"}},"description":"Configuration for integrating OpenAI compatible AI services.","required":["base_url","analyze_model","api_key","language","max_speech_to_text_concurrent","transcript_model"]}}}],"required":["provider","opts"]}}}}
```

## The http\_port object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"http_port":{"allOf":[{"type":"integer","format":"int32","minimum":0,"maximum":65535,"description":"A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535.\nFor TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port\n"}],"default":8882,"description":"The SBC web port for http.\n"}}}}
```

## The https\_port object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"https_port":{"allOf":[{"type":"integer","format":"int32","minimum":0,"maximum":65535,"description":"A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535.\nFor TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port\n"}],"default":8883,"description":"The SBC web port fot https.\n"}}}}
```

## The port-2 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"port-2":{"allOf":[{"type":"integer","format":"int32","minimum":0,"maximum":65535,"description":"A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535.\nFor TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port\n"}],"description":"The port of transport.\n"}}}}
```

## The id-4 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-4":{"allOf":[{"type":"string"}],"description":"The unique ID of dealer.\n"}}}}
```

## The id-5 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-5":{"allOf":[{"type":"string"}],"description":"The unique ID of push profile.\n"}}}}
```

## The id-6 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-6":{"allOf":[{"type":"string"}],"description":"The unique ID of IP rule.\n"}}}}
```

## The expire\_at object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"expire_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"IP rule's expire time.\n"}}}}
```

## The id-7 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-7":{"allOf":[{"type":"string"}],"description":"The unique ID of transport.\n"}}}}
```

## The id-8 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-8":{"allOf":[{"type":"string"}],"description":"The unique ID of tenant.\n"}}}}
```

## The timezone-2 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"timezone-2":{"allOf":[{"type":"string","description":"The IANA Time Zone names, such as \"Asia/Shanghai\".\n"}],"description":"Timezone for tenant.\n"}}}}
```

## The created\_at-2 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"created_at-2":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The creation time of tenant.\n"}}}}
```

## The id-9 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-9":{"allOf":[{"type":"string"}],"description":"The unique ID of trunk.\n"}}}}
```

## The id-10 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-10":{"allOf":[{"type":"string"}],"description":"The unique ID of the file.\n"}}}}
```

## The license\_usage-2 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"license_usage-2":{"allOf":[{"type":"object","required":["base","cc","advanced"],"properties":{"base":{"type":"object","required":["max","allocated"],"properties":{"max":{"type":"integer","format":"int32","minimum":0,"description":"Maximum quota assigned to the Tenant by its parent scope."},"allocated":{"type":"integer","format":"int32","minimum":0,"description":"Points currently assigned to extensions in the Tenant."}}},"cc":{"type":"object","required":["max","allocated"],"properties":{"max":{"type":"integer","format":"int32","minimum":0,"description":"Maximum quota assigned to the Tenant by its parent scope."},"allocated":{"type":"integer","format":"int32","minimum":0,"description":"Points currently assigned to extensions in the Tenant."}}},"advanced":{"type":"object","required":["max","allocated"],"properties":{"max":{"type":"integer","format":"int32","minimum":0,"description":"Maximum quota assigned to the Tenant by its parent scope."},"allocated":{"type":"integer","format":"int32","minimum":0,"description":"Points currently assigned to extensions in the Tenant."}}}}}],"description":"Current Tenant Modular License quota summary. `max` is the quota assigned\nto the Tenant by its parent scope and `allocated` is the number of points\ncurrently assigned to extensions. The field is omitted when usage cannot\nbe loaded.\n"}}}}
```

## The id-11 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-11":{"allOf":[{"type":"string"}],"description":"The unique ID of conference server.\n"}}}}
```

## The id-12 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-12":{"allOf":[{"type":"string"}],"description":"The unique ID of media server.\n"}}}}
```

## The license\_usage-3 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"license_usage-3":{"allOf":[{"type":"object","required":["base","cc","advanced"],"properties":{"base":{"type":"object","required":["max","allocated","used"],"properties":{"max":{"type":"integer","format":"int32","minimum":0,"description":"Maximum quota for the selected scope."},"allocated":{"type":"integer","format":"int32","minimum":0,"description":"Quota reserved by direct children or assigned users."},"used":{"type":"integer","format":"int32","minimum":0,"description":"Current extension usage calculated from database records."}}},"cc":{"type":"object","required":["max","allocated","used"],"properties":{"max":{"type":"integer","format":"int32","minimum":0,"description":"Maximum quota for the selected scope."},"allocated":{"type":"integer","format":"int32","minimum":0,"description":"Quota reserved by direct children or assigned users."},"used":{"type":"integer","format":"int32","minimum":0,"description":"Current extension usage calculated from database records."}}},"advanced":{"type":"object","required":["max","allocated","used"],"properties":{"max":{"type":"integer","format":"int32","minimum":0,"description":"Maximum quota for the selected scope."},"allocated":{"type":"integer","format":"int32","minimum":0,"description":"Quota reserved by direct children or assigned users."},"used":{"type":"integer","format":"int32","minimum":0,"description":"Current extension usage calculated from database records."}}}}}],"description":"Current Dealer Modular License quota summary. `allocated` is the quota\nreserved by direct child Dealers and enabled direct Tenants. `used` is the\nactual extension assignment count in enabled Tenants owned by this Dealer\nor any descendant Dealer. Each module contains only `max`, `allocated`, and\n`used`. A top-level Dealer's `max` is a virtual ceiling assigned by the\nSystem administrator and can exceed the System License total. The shared\nSystem License is checked separately when the Dealer creates, increases,\nor re-enables a Tenant. The field is omitted when usage cannot be loaded.\n"}}}}
```

## The office\_hours\_with\_mode object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"office_hours_with_mode":{"allOf":[{"type":"object","properties":{"mode":{"type":"string","enum":["GLOBAL","CUSTOM"],"description":"The office hours mode can be either:  \n- `GLOBAL`: Use global office hours.\n- `CUSTOM`: Use specific office hours.\n"}}},{"type":"object","properties":{"monday":{"type":"object","properties":{"enabled":{"type":"boolean","description":"When enabled, all day is working time, when disabled, all day is vacation time.\n"},"ranges":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","description":"The start time for office hour with format `HH:MM` in 24 hour clock, such as \"09:00\".  \nMust be earlier than `to`.\n"},"to":{"type":"string","description":"The start time for office hour with format `HH:MM` in 24 hour clock, such as \"17:00\".  \nMust be later than `from`.\n"}}},"description":"Multiple start and end time periods make up the working time.\n"}}},"tuesday":{"type":"object","properties":{"enabled":{"type":"boolean","description":"When enabled, all day is working time, when disabled, all day is vacation time.\n"},"ranges":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","description":"The start time for office hour with format `HH:MM` in 24 hour clock, such as \"09:00\".  \nMust be earlier than `to`.\n"},"to":{"type":"string","description":"The start time for office hour with format `HH:MM` in 24 hour clock, such as \"17:00\".  \nMust be later than `from`.\n"}}},"description":"Multiple start and end time periods make up the working time.\n"}}},"wednesday":{"type":"object","properties":{"enabled":{"type":"boolean","description":"When enabled, all day is working time, when disabled, all day is vacation time.\n"},"ranges":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","description":"The start time for office hour with format `HH:MM` in 24 hour clock, such as \"09:00\".  \nMust be earlier than `to`.\n"},"to":{"type":"string","description":"The start time for office hour with format `HH:MM` in 24 hour clock, such as \"17:00\".  \nMust be later than `from`.\n"}}},"description":"Multiple start and end time periods make up the working time.\n"}}},"thursday":{"type":"object","properties":{"enabled":{"type":"boolean","description":"When enabled, all day is working time, when disabled, all day is vacation time.\n"},"ranges":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","description":"The start time for office hour with format `HH:MM` in 24 hour clock, such as \"09:00\".  \nMust be earlier than `to`.\n"},"to":{"type":"string","description":"The start time for office hour with format `HH:MM` in 24 hour clock, such as \"17:00\".  \nMust be later than `from`.\n"}}},"description":"Multiple start and end time periods make up the working time.\n"}}},"friday":{"type":"object","properties":{"enabled":{"type":"boolean","description":"When enabled, all day is working time, when disabled, all day is vacation time.\n"},"ranges":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","description":"The start time for office hour with format `HH:MM` in 24 hour clock, such as \"09:00\".  \nMust be earlier than `to`.\n"},"to":{"type":"string","description":"The start time for office hour with format `HH:MM` in 24 hour clock, such as \"17:00\".  \nMust be later than `from`.\n"}}},"description":"Multiple start and end time periods make up the working time.\n"}}},"saturday":{"type":"object","properties":{"enabled":{"type":"boolean","description":"When enabled, all day is working time, when disabled, all day is vacation time.\n"},"ranges":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","description":"The start time for office hour with format `HH:MM` in 24 hour clock, such as \"09:00\".  \nMust be earlier than `to`.\n"},"to":{"type":"string","description":"The start time for office hour with format `HH:MM` in 24 hour clock, such as \"17:00\".  \nMust be later than `from`.\n"}}},"description":"Multiple start and end time periods make up the working time.\n"}}},"sunday":{"type":"object","properties":{"enabled":{"type":"boolean","description":"When enabled, all day is working time, when disabled, all day is vacation time.\n"},"ranges":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","description":"The start time for office hour with format `HH:MM` in 24 hour clock, such as \"09:00\".  \nMust be earlier than `to`.\n"},"to":{"type":"string","description":"The start time for office hour with format `HH:MM` in 24 hour clock, such as \"17:00\".  \nMust be later than `from`.\n"}}},"description":"Multiple start and end time periods make up the working time.\n"}}}}}]}}}}
```

## The profile object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"profile":{"allOf":[{"type":"string"}],"description":"The unique ID of user profile file.\n"}}}}
```

## The timezone-3 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"timezone-3":{"allOf":[{"type":"string","description":"The IANA Time Zone names, such as \"Asia/Shanghai\".\n"}],"description":"Timezone for extension user.\n"}}}}
```

## The id-13 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-13":{"allOf":[{"type":"string"}],"description":"The unique ID of greeting.\n"}}}}
```

## The id-14 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-14":{"allOf":[{"type":"string"}],"description":"The unique ID of phone.\n"}}}}
```

## The mac-2 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"mac-2":{"allOf":[{"type":"string","description":"MAC address.\n"}],"description":"MAC address of this IP phone.\n"}}}}
```

## The id-15 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-15":{"allOf":[{"type":"string"}],"description":"The unique ID of CDR.\n"}}}}
```

## The started\_at object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"started_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The start time of the call.\n"}}}}
```

## The rang\_at object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"rang_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The ringing time of the call.\n"}}}}
```

## The answered\_at object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"answered_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The answer time of the call.\n"}}}}
```

## The ended\_at object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"ended_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The end time of the call.\n"}}}}
```

## The id-16 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-16":{"allOf":[{"type":"string"}],"description":"The unique ID of external message.\n"}}}}
```

## The created\_at-3 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"created_at-3":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The creation time of the message.\n"}}}}
```

## The id-17 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-17":{"allOf":[{"type":"string"}],"readOnly":true,"description":"The unique ID of call recording.\n"}}}}
```

## The started\_at-2 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"started_at-2":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Time on which the call is answered.\n"}}}}
```

## The ended\_at-2 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"ended_at-2":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Time on which the call is ended.\n"}}}}
```

## The session\_id object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"session_id":{"allOf":[{"type":"string"}],"description":"The session ID of call log.\n"}}}}
```

## The id-19 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-19":{"allOf":[{"type":"string"}],"description":"The unique ID of speed dial.\n"}}}}
```

## The id-20 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-20":{"allOf":[{"type":"string"}],"description":"The unique ID of conference room.\n"}}}}
```

## The created\_at-5 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"created_at-5":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The creation time of conference room.\n"}}}}
```

## The scheduled\_start\_at object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"scheduled_start_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The scheduled start time of meeting.\n"}}}}
```

## The scheduled\_end\_at object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"scheduled_end_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The scheduled end time of meeting.\n"}}}}
```

## The participant\_id object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"participant_id":{"allOf":[{"type":"string"}],"description":"The unique ID of conference room participant.\n"}}}}
```

## The id-21 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-21":{"allOf":[{"type":"string"}],"description":"The unique ID of contact.\n"}}}}
```

## The id-22 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-22":{"allOf":[{"type":"string"}],"description":"The unique ID of call queue.\n"}}}}
```

## The extension\_number-2 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"extension_number-2":{"allOf":[{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"}],"description":"The extension number of call queue.\n"}}}}
```

## The id-23 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-23":{"allOf":[{"type":"string"}],"description":"The unique ID of ring group.\n"}}}}
```

## The id-24 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-24":{"allOf":[{"type":"string"}],"description":"The unique ID of session.\n"}}}}
```

## The started\_at-3 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"started_at-3":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The start time of the call session.\n"}}}}
```

## The assistant\_id object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"assistant_id":{"allOf":[{"type":"string"}],"description":"The unique ID of assistant.\n"}}}}
```

## The id-25 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-25":{"allOf":[{"type":"string"}],"description":"The unique ID of assistant filter.\n"}}}}
```

## The executive\_id object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"executive_id":{"allOf":[{"type":"string"}],"description":"The unique ID of executive.\n"}}}}
```

## The id-28 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-28":{"allOf":[{"type":"string"}],"description":"The unique ID of user group.\n"}}}}
```

## The id-29 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-29":{"allOf":[{"type":"string"}],"description":"The unique ID of voicemail.\n"}}}}
```

## The created\_at-6 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"created_at-6":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The creation time of voicemail.\n"}}}}
```

## The id-30 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-30":{"allOf":[{"type":"string"}],"description":"The unique ID of call queue server.\n"}}}}
```

## The session\_id-2 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"session_id-2":{"allOf":[{"type":"string"}],"description":"The unique ID of session in call queue.\n"}}}}
```

## The id-31 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-31":{"allOf":[{"type":"string"}],"description":"The unique ID of exclusive number.\n"}}}}
```

## The created\_at-7 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"created_at-7":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Exclusive number created at this time.\n"}}}}
```

## The id-32 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-32":{"allOf":[{"type":"string"}],"description":"The unique ID of VIP number.\n"}}}}
```

## The updated\_at object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"updated_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"VIP number's modified time.\n"}}}}
```

## The expire\_at-2 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"expire_at-2":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"VIP number's expire time.\n"}}}}
```

## The id-33 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-33":{"allOf":[{"type":"string"}],"description":"The unique ID of blacklisted number.\n"}}}}
```

## The created\_at-8 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"created_at-8":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The creation time of blacklisted number.\n"}}}}
```

## The updated\_at-2 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"updated_at-2":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Blacklisted number's modified time.\n"}}}}
```

## The expire\_at-3 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"expire_at-3":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Blacklisted number's expire time.\n"}}}}
```

## The id-34 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-34":{"allOf":[{"type":"string"}],"description":"The unique ID of conference recording.\n"}}}}
```

## The answered\_at-2 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"answered_at-2":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Time on which the call is answered.\n"}}}}
```

## The id-35 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-35":{"allOf":[{"type":"string"}],"description":"The unique ID of emergency number.\n"}}}}
```

## The created\_at-9 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"created_at-9":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The creation time of the file.\n"}}}}
```

## The id-36 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-36":{"allOf":[{"type":"string"}],"description":"The unique ID of inbound rule.\n"}}}}
```

## The id-37 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-37":{"allOf":[{"type":"string"}],"description":"The unique ID of MOH music.\n"}}}}
```

## The extension\_number-3 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"extension_number-3":{"allOf":[{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"}],"description":"The extension number of monitor server.\n"}}}}
```

## The id-38 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-38":{"allOf":[{"type":"string"}],"description":"The unique ID of monitor group.\n"}}}}
```

## The extension\_number-4 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"extension_number-4":{"allOf":[{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"}],"description":"Extension number used by call park server.\n"}}}}
```

## The ring\_group\_id object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"ring_group_id":{"allOf":[{"allOf":[{"type":"string"}],"description":"The unique ID of ring group.\n"}],"description":"The unique ID of ring group.\nSelect a Ring Group as the Recall destination. \nOnly valid when the value of `recall_to` is `USER_FIRST_THEN_RING_GROUP` or `RING_GROUP_ONLY`.\n"}}}}
```

## The id-39 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-39":{"allOf":[{"type":"string"}],"description":"The unique ID of call park group.\n"}}}}
```

## The id-40 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-40":{"allOf":[{"type":"string"}],"description":"The unique ID of call pick group.\n"}}}}
```

## The extension\_number-5 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"extension_number-5":{"allOf":[{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"}],"description":"The extension number of voicemail server."}}}}
```

## The extension\_number-6 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"extension_number-6":{"allOf":[{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"}],"description":"The extension number of automatic callback service.\n"}}}}
```

## The id-41 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-41":{"allOf":[{"type":"string"}],"description":"The unique ID of outbound rule.\n"}}}}
```

## The id-42 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-42":{"allOf":[{"type":"string"}],"description":"The unique ID of DECT phone.\n"}}}}
```

## The hostname-2 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"hostname-2":{"allOf":[{"type":"string","description":"Server hostname or IP address\n"}],"description":"The hostname of trunk.\n"}}}}
```

## The port-3 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"port-3":{"allOf":[{"type":"integer","format":"int32","minimum":0,"maximum":65535,"description":"A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535.\nFor TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port\n"}],"description":"The port of trunk.\n"}}}}
```

## The outbound\_server\_port object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"outbound_server_port":{"allOf":[{"type":"integer","format":"int32","minimum":0,"maximum":65535,"description":"A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535.\nFor TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port\n"}],"description":"The outbound server port of the trunk.\n"}}}}
```

## The id-43 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-43":{"allOf":[{"type":"string"}],"description":"The unique ID of shared voicemail.\n"}}}}
```

## The prompt object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"prompt":{"allOf":[{"type":"string","description":"BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags).\nA language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags.\nWhen a language tag is comprised of more than one subtag, the subtag values are separated by the \"-\" character.\nYou will most commonly find language tags written with 2 subtags - language and region. For example: en-US.\n"}],"description":"The prompt set name of shared voicemail.\n"}}}}
```

## The id-44 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-44":{"allOf":[{"type":"string"}],"description":"The unique ID of blocked code.\n"}}}}
```

## The id-45 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-45":{"allOf":[{"type":"string"}],"description":"The unique ID of this blacklisted number.\n"}}}}
```

## The created\_at-10 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"created_at-10":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Blacklisted number's creation time.\n"}}}}
```

## The updated\_at-3 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"updated_at-3":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Blacklisted number's last updated time.\n"}}}}
```

## The id-46 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-46":{"allOf":[{"type":"string"}],"description":"The unique ID of billing.\n"}}}}
```

## The id-47 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-47":{"allOf":[{"type":"string"}],"description":"The unique ID of virtual receptionist server.\n"}}}}
```

## The id-48 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-48":{"allOf":[{"type":"string"}],"description":"The unique ID of virtual receptionist.\n"}}}}
```

## The id-49 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-49":{"allOf":[{"type":"string"}],"description":"The unique ID of action url.\n"}}}}
```

## The id-50 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-50":{"allOf":[{"type":"string"}],"description":"The unique ID of hot desking.\n"}}}}
```

## The extension\_number-7 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"extension_number-7":{"allOf":[{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"}],"description":"The extension number of hot desking.\n"}}}}
```

## The current\_extension\_number object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"current_extension_number":{"allOf":[{"type":"string","minLength":3,"maxLength":64,"pattern":"[0-9]{3,64}","description":"The extension number.\n"}],"description":"The current extension number of hot desking.\n"}}}}
```

## The extension\_password-3 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"extension_password-3":{"allOf":[{"type":"string","description":"The extension password.\n"}],"description":"The extension password of hot desking.\n"}}}}
```

## The id-51 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-51":{"allOf":[{"type":"string"}],"description":"The unique ID of SMS/MMS service.\n"}}}}
```

## The id-52 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-52":{"allOf":[{"type":"string"}],"description":"The unique ID of WhatsApp service.\n"}}}}
```

## The id-54 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-54":{"allOf":[{"type":"string"}],"description":"The unique ID of this call report.\n"}}}}
```

## The email-4 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"email-4":{"allOf":[{"type":"string","maxLength":128,"description":"The email address.\n"}],"description":"The email address to which the report file will be sent after the report is complete.\n"}}}}
```

## The started\_at-4 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"started_at-4":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Filter data after specified data time.  \nOnly valid when the `range` is specified as `CUSTOM`\n"}}}}
```

## The ended\_at-3 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"ended_at-3":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Filter data before specified data time.  \nOnly valid when the `range` is specified as `CUSTOM`\n"}}}}
```

## The completed\_at object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"completed_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The completed time of call report.\n"}}}}
```

## The id-55 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-55":{"allOf":[{"type":"string"}],"description":"The unique ID of audit log.\n"}}}}
```

## The created\_at-12 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"created_at-12":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The creation time of the audit log.\n"}}}}
```

## The ip-2 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"ip-2":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The IP address of the audit log.\n"}}}}
```

## The id-56 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-56":{"allOf":[{"type":"string"}],"description":"The unique ID of event log.\n"}}}}
```

## The created\_at-13 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"created_at-13":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"The creation time of the event log.\n"}}}}
```

## The saml\_auth\_config object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"saml_auth_config":{"type":"object","required":["client_id","saml_metadata_source"],"allOf":[{"oneOf":[{"title":"Metadata URL","properties":{"saml_metadata_source":{"const":"metadata_url"},"saml_metadata_url":{"type":"string"}},"required":["saml_metadata_url"]},{"title":"Metadata XML","properties":{"saml_metadata_source":{"const":"metadata_xml"},"saml_metadata_xml":{"type":"string"}},"required":["saml_metadata_xml"]},{"title":"Manual SAML endpoints and certificate","properties":{"saml_metadata_source":{"const":"manual"},"issuer":{"type":"string"},"saml_sso_url":{"type":"string"},"saml_signing_certificate":{"type":"string"}},"required":["issuer","saml_sso_url","saml_signing_certificate"]}]}],"properties":{"issuer":{"type":"string","description":"The SAML IdP Entity ID. Required and used only when `saml_metadata_source` is `manual`; metadata supplies it in the other modes."},"client_id":{"type":"string","description":"Required for SAML sign-in. The PBX SAML service-provider (SP) Entity ID."},"saml_metadata_source":{"type":"string","enum":["metadata_url","metadata_xml","manual"],"default":"metadata_url","description":"Selects the only SAML configuration source used at runtime. `metadata_url` downloads IdP metadata,\n`metadata_xml` parses pasted IdP metadata, and `manual` uses `issuer`, `saml_sso_url`, and\n`saml_signing_certificate`. Values retained for inactive sources are ignored.\n"},"saml_sso_url":{"type":"string","description":"The IdP SSO endpoint URL. Required and used only when `saml_metadata_source` is `manual`."},"saml_metadata_url":{"type":"string","description":"Required and used only when `saml_metadata_source` is `metadata_url`. PBX downloads and parses the IdP metadata. Like every other outbound request of the Generic IdP integration (OIDC discovery/token/JWKS, SAML metadata, SCIM requests and their token endpoint), HTTPS requests skip TLS server certificate validation for private IdP compatibility, including chain, hostname and validity checks. This carries a man-in-the-middle risk; use only a trusted endpoint/network. SAML response signature validation remains enabled. The policy is limited to the Generic IdP integration and does not affect other outbound HTTPS connections such as Microsoft 365, Google, SMTP or S3."},"saml_metadata_xml":{"type":"string","description":"Required and used only when `saml_metadata_source` is `metadata_xml`. Paste the complete IdP metadata XML document."},"saml_signing_certificate":{"type":"string","description":"Required and used only when `saml_metadata_source` is `manual`. Accepts one PEM-encoded X.509 certificate or its Base64 DER content. PBX validates and normalizes it to Base64 DER. This is public certificate material and is returned by GET."},"saml_name_id_format":{"type":"string","default":"urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified","description":"SAML AuthnRequest NameID format. Defaults to `urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified` when omitted. Standard or IdP-specific URI values are accepted for compatibility."}}}}}}
```

## The id-58 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-58":{"allOf":[{"type":"string"}],"description":"The unique ID of CRM call.\n"}}}}
```

## The callback\_id object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"callback_id":{"allOf":[{"type":"string"}],"description":"Optional field. Multiple CDRs with the same callback_id belong to the same callback process."}}}}
```

## The report\_abandon\_delay object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"report_abandon_delay":{"allOf":[{"type":"object","properties":{"id":{"allOf":[{"type":"string"}],"description":"The unique ID of report.","readOnly":true},"type":{"type":"string","enum":["ABANDONDELAY","AGENTDETAILSACTIVITY","AGENTNOTREADYCODE","AGENTQUEUEREPORT","AGENTSUMMARYACTIVITY","CALLBACKSUMMARY","CALLLOGS","DAILYSTATISTICS","QUEUESUMMARY","RINGGROUPPERFORMANCE","SPEEDOFACCEPT","USERSTATISTICS"],"description":"Report type, string enum."},"format":{"type":"string","description":"Report file format:CSV、HTML","enum":["CSV","HTML"]},"schedule_name":{"type":"string","description":"Report Job name"},"create_time":{"type":"string","format":"date-time","description":"The timestamp when the report log entry was created."},"start_time":{"type":"string","description":"Start time; task will not run before this time"},"end_time":{"type":"string","description":"End time"},"cron_expr":{"type":"string","description":"crontab string, e.g.:\nEvery day at 00:01 = 1 0 * * *\nEvery month on 1st at 02:03 = 3 2 1 * *\nEvery Tuesday at 01:02 = 2 1 * * 2"},"active":{"type":"boolean","description":"Whether the task is active"},"time_zone":{"type":"string","description":"Time zone, e.g., Asia/Shanghai"},"recipients":{"type":"string","description":"Recipient emails; multiple emails separated by semicolon"},"last_run_time":{"type":"string","format":"date-time","description":"The timestamp of the most recent execution of the report job."}}},{"type":"object","properties":{"params":{"allOf":[{"type":"object","properties":{"stx":{"type":"array","items":{"type":"integer","minimum":1,"maximum":3600},"minItems":10,"maxItems":10,"description":"Accepted Agent ST1-ST10 configuration.\nThis array contains exactly 10 integer values.\nValid range for each value is 1-3600 seconds.\n**Values must be in ascending order (ST1 < ST2 < … < ST10).**\n"}}},{"type":"object","required":["from","to","time_range"],"properties":{"from":{"type":"string","description":"Start time."},"to":{"type":"string","description":"End time."},"time_range":{"type":"string","description":"Time range preset.","enum":["TODAY","YESTERDAY","LAST_WEEK","LAST_SEVEN_DAYS","LAST_MONTH","LAST_THIRTY_DAYS","CUSTOM"]}}},{"type":"object","required":["queue"],"properties":{"queue":{"type":"array","items":{"type":"string","description":"Queue number."}}}}]}}}],"required":["type"],"title":"Abandon Delay"}}}}
```

## The report\_agent\_activity\_details object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"report_agent_activity_details":{"allOf":[{"type":"object","properties":{"id":{"allOf":[{"type":"string"}],"description":"The unique ID of report.","readOnly":true},"type":{"type":"string","enum":["ABANDONDELAY","AGENTDETAILSACTIVITY","AGENTNOTREADYCODE","AGENTQUEUEREPORT","AGENTSUMMARYACTIVITY","CALLBACKSUMMARY","CALLLOGS","DAILYSTATISTICS","QUEUESUMMARY","RINGGROUPPERFORMANCE","SPEEDOFACCEPT","USERSTATISTICS"],"description":"Report type, string enum."},"format":{"type":"string","description":"Report file format:CSV、HTML","enum":["CSV","HTML"]},"schedule_name":{"type":"string","description":"Report Job name"},"create_time":{"type":"string","format":"date-time","description":"The timestamp when the report log entry was created."},"start_time":{"type":"string","description":"Start time; task will not run before this time"},"end_time":{"type":"string","description":"End time"},"cron_expr":{"type":"string","description":"crontab string, e.g.:\nEvery day at 00:01 = 1 0 * * *\nEvery month on 1st at 02:03 = 3 2 1 * *\nEvery Tuesday at 01:02 = 2 1 * * 2"},"active":{"type":"boolean","description":"Whether the task is active"},"time_zone":{"type":"string","description":"Time zone, e.g., Asia/Shanghai"},"recipients":{"type":"string","description":"Recipient emails; multiple emails separated by semicolon"},"last_run_time":{"type":"string","format":"date-time","description":"The timestamp of the most recent execution of the report job."}}},{"type":"object","properties":{"params":{"allOf":[{"type":"object","properties":{"agent":{"type":"string","description":"Agent number."},"queue":{"type":"string","description":"Queue number."},"channel_type":{"type":"string","description":"Channel type for filtering report data."}}},{"type":"object","required":["from","to","time_range"],"properties":{"from":{"type":"string","description":"Start time."},"to":{"type":"string","description":"End time."},"time_range":{"type":"string","description":"Time range preset.","enum":["TODAY","YESTERDAY","LAST_WEEK","LAST_SEVEN_DAYS","LAST_MONTH","LAST_THIRTY_DAYS","CUSTOM"]}}}]}}}],"title":"Agent Activity Details"}}}}
```

## The report\_agent\_not\_ready\_code object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"report_agent_not_ready_code":{"allOf":[{"type":"object","properties":{"id":{"allOf":[{"type":"string"}],"description":"The unique ID of report.","readOnly":true},"type":{"type":"string","enum":["ABANDONDELAY","AGENTDETAILSACTIVITY","AGENTNOTREADYCODE","AGENTQUEUEREPORT","AGENTSUMMARYACTIVITY","CALLBACKSUMMARY","CALLLOGS","DAILYSTATISTICS","QUEUESUMMARY","RINGGROUPPERFORMANCE","SPEEDOFACCEPT","USERSTATISTICS"],"description":"Report type, string enum."},"format":{"type":"string","description":"Report file format:CSV、HTML","enum":["CSV","HTML"]},"schedule_name":{"type":"string","description":"Report Job name"},"create_time":{"type":"string","format":"date-time","description":"The timestamp when the report log entry was created."},"start_time":{"type":"string","description":"Start time; task will not run before this time"},"end_time":{"type":"string","description":"End time"},"cron_expr":{"type":"string","description":"crontab string, e.g.:\nEvery day at 00:01 = 1 0 * * *\nEvery month on 1st at 02:03 = 3 2 1 * *\nEvery Tuesday at 01:02 = 2 1 * * 2"},"active":{"type":"boolean","description":"Whether the task is active"},"time_zone":{"type":"string","description":"Time zone, e.g., Asia/Shanghai"},"recipients":{"type":"string","description":"Recipient emails; multiple emails separated by semicolon"},"last_run_time":{"type":"string","format":"date-time","description":"The timestamp of the most recent execution of the report job."}}},{"type":"object","properties":{"params":{"allOf":[{"type":"object","properties":{"queue":{"type":"string","description":"Queue number."},"reason_code":{"type":"string","description":"Reason code for agent not ready status."}}},{"type":"object","required":["from","to","time_range"],"properties":{"from":{"type":"string","description":"Start time."},"to":{"type":"string","description":"End time."},"time_range":{"type":"string","description":"Time range preset.","enum":["TODAY","YESTERDAY","LAST_WEEK","LAST_SEVEN_DAYS","LAST_MONTH","LAST_THIRTY_DAYS","CUSTOM"]}}},{"type":"object","required":["agent"],"properties":{"agent":{"type":"array","items":{"type":"string","description":"Agent number."}}}}]}}}],"title":"Agent Not Ready Code"}}}}
```

## The report\_agent\_queue\_report object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"report_agent_queue_report":{"allOf":[{"type":"object","properties":{"id":{"allOf":[{"type":"string"}],"description":"The unique ID of report.","readOnly":true},"type":{"type":"string","enum":["ABANDONDELAY","AGENTDETAILSACTIVITY","AGENTNOTREADYCODE","AGENTQUEUEREPORT","AGENTSUMMARYACTIVITY","CALLBACKSUMMARY","CALLLOGS","DAILYSTATISTICS","QUEUESUMMARY","RINGGROUPPERFORMANCE","SPEEDOFACCEPT","USERSTATISTICS"],"description":"Report type, string enum."},"format":{"type":"string","description":"Report file format:CSV、HTML","enum":["CSV","HTML"]},"schedule_name":{"type":"string","description":"Report Job name"},"create_time":{"type":"string","format":"date-time","description":"The timestamp when the report log entry was created."},"start_time":{"type":"string","description":"Start time; task will not run before this time"},"end_time":{"type":"string","description":"End time"},"cron_expr":{"type":"string","description":"crontab string, e.g.:\nEvery day at 00:01 = 1 0 * * *\nEvery month on 1st at 02:03 = 3 2 1 * *\nEvery Tuesday at 01:02 = 2 1 * * 2"},"active":{"type":"boolean","description":"Whether the task is active"},"time_zone":{"type":"string","description":"Time zone, e.g., Asia/Shanghai"},"recipients":{"type":"string","description":"Recipient emails; multiple emails separated by semicolon"},"last_run_time":{"type":"string","format":"date-time","description":"The timestamp of the most recent execution of the report job."}}},{"type":"object","properties":{"params":{"allOf":[{"type":"object","required":["from","to","time_range"],"properties":{"from":{"type":"string","description":"Start time."},"to":{"type":"string","description":"End time."},"time_range":{"type":"string","description":"Time range preset.","enum":["TODAY","YESTERDAY","LAST_WEEK","LAST_SEVEN_DAYS","LAST_MONTH","LAST_THIRTY_DAYS","CUSTOM"]}}},{"type":"object","required":["queue"],"properties":{"queue":{"type":"array","items":{"type":"string","description":"Queue number."}}}}]}}}],"title":"Agent Queue Report"}}}}
```

## The report\_agent\_activity\_summary object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"report_agent_activity_summary":{"allOf":[{"type":"object","properties":{"id":{"allOf":[{"type":"string"}],"description":"The unique ID of report.","readOnly":true},"type":{"type":"string","enum":["ABANDONDELAY","AGENTDETAILSACTIVITY","AGENTNOTREADYCODE","AGENTQUEUEREPORT","AGENTSUMMARYACTIVITY","CALLBACKSUMMARY","CALLLOGS","DAILYSTATISTICS","QUEUESUMMARY","RINGGROUPPERFORMANCE","SPEEDOFACCEPT","USERSTATISTICS"],"description":"Report type, string enum."},"format":{"type":"string","description":"Report file format:CSV、HTML","enum":["CSV","HTML"]},"schedule_name":{"type":"string","description":"Report Job name"},"create_time":{"type":"string","format":"date-time","description":"The timestamp when the report log entry was created."},"start_time":{"type":"string","description":"Start time; task will not run before this time"},"end_time":{"type":"string","description":"End time"},"cron_expr":{"type":"string","description":"crontab string, e.g.:\nEvery day at 00:01 = 1 0 * * *\nEvery month on 1st at 02:03 = 3 2 1 * *\nEvery Tuesday at 01:02 = 2 1 * * 2"},"active":{"type":"boolean","description":"Whether the task is active"},"time_zone":{"type":"string","description":"Time zone, e.g., Asia/Shanghai"},"recipients":{"type":"string","description":"Recipient emails; multiple emails separated by semicolon"},"last_run_time":{"type":"string","format":"date-time","description":"The timestamp of the most recent execution of the report job."}}},{"type":"object","properties":{"params":{"allOf":[{"type":"object","properties":{"queue":{"type":"string","description":"Queue number."}}},{"type":"object","required":["from","to","time_range"],"properties":{"from":{"type":"string","description":"Start time."},"to":{"type":"string","description":"End time."},"time_range":{"type":"string","description":"Time range preset.","enum":["TODAY","YESTERDAY","LAST_WEEK","LAST_SEVEN_DAYS","LAST_MONTH","LAST_THIRTY_DAYS","CUSTOM"]}}},{"type":"object","required":["agent"],"properties":{"agent":{"type":"array","items":{"type":"string","description":"Agent number."}}}}]}}}],"title":"Agent Activity Summary"}}}}
```

## The report\_callback\_summary object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"report_callback_summary":{"allOf":[{"type":"object","properties":{"id":{"allOf":[{"type":"string"}],"description":"The unique ID of report.","readOnly":true},"type":{"type":"string","enum":["ABANDONDELAY","AGENTDETAILSACTIVITY","AGENTNOTREADYCODE","AGENTQUEUEREPORT","AGENTSUMMARYACTIVITY","CALLBACKSUMMARY","CALLLOGS","DAILYSTATISTICS","QUEUESUMMARY","RINGGROUPPERFORMANCE","SPEEDOFACCEPT","USERSTATISTICS"],"description":"Report type, string enum."},"format":{"type":"string","description":"Report file format:CSV、HTML","enum":["CSV","HTML"]},"schedule_name":{"type":"string","description":"Report Job name"},"create_time":{"type":"string","format":"date-time","description":"The timestamp when the report log entry was created."},"start_time":{"type":"string","description":"Start time; task will not run before this time"},"end_time":{"type":"string","description":"End time"},"cron_expr":{"type":"string","description":"crontab string, e.g.:\nEvery day at 00:01 = 1 0 * * *\nEvery month on 1st at 02:03 = 3 2 1 * *\nEvery Tuesday at 01:02 = 2 1 * * 2"},"active":{"type":"boolean","description":"Whether the task is active"},"time_zone":{"type":"string","description":"Time zone, e.g., Asia/Shanghai"},"recipients":{"type":"string","description":"Recipient emails; multiple emails separated by semicolon"},"last_run_time":{"type":"string","format":"date-time","description":"The timestamp of the most recent execution of the report job."}}},{"type":"object","properties":{"params":{"allOf":[{"type":"object","required":["from","to","time_range"],"properties":{"from":{"type":"string","description":"Start time."},"to":{"type":"string","description":"End time."},"time_range":{"type":"string","description":"Time range preset.","enum":["TODAY","YESTERDAY","LAST_WEEK","LAST_SEVEN_DAYS","LAST_MONTH","LAST_THIRTY_DAYS","CUSTOM"]}}},{"type":"object","required":["queue"],"properties":{"queue":{"type":"array","items":{"type":"string","description":"Queue number."}}}}]}}}],"required":["type"],"title":"Callback Summary"}}}}
```

## The report\_calllogs object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"report_calllogs":{"allOf":[{"type":"object","properties":{"id":{"allOf":[{"type":"string"}],"description":"The unique ID of report.","readOnly":true},"type":{"type":"string","enum":["ABANDONDELAY","AGENTDETAILSACTIVITY","AGENTNOTREADYCODE","AGENTQUEUEREPORT","AGENTSUMMARYACTIVITY","CALLBACKSUMMARY","CALLLOGS","DAILYSTATISTICS","QUEUESUMMARY","RINGGROUPPERFORMANCE","SPEEDOFACCEPT","USERSTATISTICS"],"description":"Report type, string enum."},"format":{"type":"string","description":"Report file format:CSV、HTML","enum":["CSV","HTML"]},"schedule_name":{"type":"string","description":"Report Job name"},"create_time":{"type":"string","format":"date-time","description":"The timestamp when the report log entry was created."},"start_time":{"type":"string","description":"Start time; task will not run before this time"},"end_time":{"type":"string","description":"End time"},"cron_expr":{"type":"string","description":"crontab string, e.g.:\nEvery day at 00:01 = 1 0 * * *\nEvery month on 1st at 02:03 = 3 2 1 * *\nEvery Tuesday at 01:02 = 2 1 * * 2"},"active":{"type":"boolean","description":"Whether the task is active"},"time_zone":{"type":"string","description":"Time zone, e.g., Asia/Shanghai"},"recipients":{"type":"string","description":"Recipient emails; multiple emails separated by semicolon"},"last_run_time":{"type":"string","format":"date-time","description":"The timestamp of the most recent execution of the report job."}}},{"type":"object","properties":{"params":{"allOf":[{"type":"object","required":["from","to","time_range"],"properties":{"from":{"type":"string","description":"Start time."},"to":{"type":"string","description":"End time."},"time_range":{"type":"string","description":"Time range preset.","enum":["TODAY","YESTERDAY","LAST_WEEK","LAST_SEVEN_DAYS","LAST_MONTH","LAST_THIRTY_DAYS","CUSTOM"]}}},{"type":"object","required":["status","direction"],"properties":{"status":{"type":"string","description":"Call status.\n","enum":["NONE","ANSWERED","UNANSWERED"]},"direction":{"type":"string","description":"Call direction type, indicating the routing path of the call.","enum":["NONE","INBOUND","OUTBOUND","INTERNAL"]}}}]}}}],"title":"Calllogs"}}}}
```

## The report\_daily\_statistics object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"report_daily_statistics":{"allOf":[{"type":"object","properties":{"id":{"allOf":[{"type":"string"}],"description":"The unique ID of report.","readOnly":true},"type":{"type":"string","enum":["ABANDONDELAY","AGENTDETAILSACTIVITY","AGENTNOTREADYCODE","AGENTQUEUEREPORT","AGENTSUMMARYACTIVITY","CALLBACKSUMMARY","CALLLOGS","DAILYSTATISTICS","QUEUESUMMARY","RINGGROUPPERFORMANCE","SPEEDOFACCEPT","USERSTATISTICS"],"description":"Report type, string enum."},"format":{"type":"string","description":"Report file format:CSV、HTML","enum":["CSV","HTML"]},"schedule_name":{"type":"string","description":"Report Job name"},"create_time":{"type":"string","format":"date-time","description":"The timestamp when the report log entry was created."},"start_time":{"type":"string","description":"Start time; task will not run before this time"},"end_time":{"type":"string","description":"End time"},"cron_expr":{"type":"string","description":"crontab string, e.g.:\nEvery day at 00:01 = 1 0 * * *\nEvery month on 1st at 02:03 = 3 2 1 * *\nEvery Tuesday at 01:02 = 2 1 * * 2"},"active":{"type":"boolean","description":"Whether the task is active"},"time_zone":{"type":"string","description":"Time zone, e.g., Asia/Shanghai"},"recipients":{"type":"string","description":"Recipient emails; multiple emails separated by semicolon"},"last_run_time":{"type":"string","format":"date-time","description":"The timestamp of the most recent execution of the report job."}}},{"type":"object","properties":{"params":{"allOf":[{"type":"object","required":["from","to","time_range"],"properties":{"from":{"type":"string","description":"Start time."},"to":{"type":"string","description":"End time."},"time_range":{"type":"string","description":"Time range preset.","enum":["TODAY","YESTERDAY","LAST_WEEK","LAST_SEVEN_DAYS","LAST_MONTH","LAST_THIRTY_DAYS","CUSTOM"]}}},{"type":"object","required":["status","direction"],"properties":{"status":{"type":"string","description":"Call status.\n","enum":["NONE","ANSWERED","UNANSWERED"]},"direction":{"type":"string","description":"Call direction type, indicating the routing path of the call.","enum":["NONE","INBOUND","OUTBOUND","INTERNAL"]}}}]}}}],"title":"Daily Statistics"}}}}
```

## The report\_queue\_summary object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"report_queue_summary":{"allOf":[{"type":"object","properties":{"id":{"allOf":[{"type":"string"}],"description":"The unique ID of report.","readOnly":true},"type":{"type":"string","enum":["ABANDONDELAY","AGENTDETAILSACTIVITY","AGENTNOTREADYCODE","AGENTQUEUEREPORT","AGENTSUMMARYACTIVITY","CALLBACKSUMMARY","CALLLOGS","DAILYSTATISTICS","QUEUESUMMARY","RINGGROUPPERFORMANCE","SPEEDOFACCEPT","USERSTATISTICS"],"description":"Report type, string enum."},"format":{"type":"string","description":"Report file format:CSV、HTML","enum":["CSV","HTML"]},"schedule_name":{"type":"string","description":"Report Job name"},"create_time":{"type":"string","format":"date-time","description":"The timestamp when the report log entry was created."},"start_time":{"type":"string","description":"Start time; task will not run before this time"},"end_time":{"type":"string","description":"End time"},"cron_expr":{"type":"string","description":"crontab string, e.g.:\nEvery day at 00:01 = 1 0 * * *\nEvery month on 1st at 02:03 = 3 2 1 * *\nEvery Tuesday at 01:02 = 2 1 * * 2"},"active":{"type":"boolean","description":"Whether the task is active"},"time_zone":{"type":"string","description":"Time zone, e.g., Asia/Shanghai"},"recipients":{"type":"string","description":"Recipient emails; multiple emails separated by semicolon"},"last_run_time":{"type":"string","format":"date-time","description":"The timestamp of the most recent execution of the report job."}}},{"type":"object","properties":{"params":{"allOf":[{"type":"object","properties":{"queue":{"type":"object","additionalProperties":{"type":"integer","description":"SLA time for the user (e.g., in seconds)"},"description":"Key-value map where:\n  - **key** is the user number (string),\n  - **value** is the SLA time for that user.\n"}}},{"type":"object","required":["from","to","time_range"],"properties":{"from":{"type":"string","description":"Start time."},"to":{"type":"string","description":"End time."},"time_range":{"type":"string","description":"Time range preset.","enum":["TODAY","YESTERDAY","LAST_WEEK","LAST_SEVEN_DAYS","LAST_MONTH","LAST_THIRTY_DAYS","CUSTOM"]}}}]}}}],"title":"Queue Summary"}}}}
```

## The report\_ring\_group\_performance object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"report_ring_group_performance":{"allOf":[{"type":"object","properties":{"id":{"allOf":[{"type":"string"}],"description":"The unique ID of report.","readOnly":true},"type":{"type":"string","enum":["ABANDONDELAY","AGENTDETAILSACTIVITY","AGENTNOTREADYCODE","AGENTQUEUEREPORT","AGENTSUMMARYACTIVITY","CALLBACKSUMMARY","CALLLOGS","DAILYSTATISTICS","QUEUESUMMARY","RINGGROUPPERFORMANCE","SPEEDOFACCEPT","USERSTATISTICS"],"description":"Report type, string enum."},"format":{"type":"string","description":"Report file format:CSV、HTML","enum":["CSV","HTML"]},"schedule_name":{"type":"string","description":"Report Job name"},"create_time":{"type":"string","format":"date-time","description":"The timestamp when the report log entry was created."},"start_time":{"type":"string","description":"Start time; task will not run before this time"},"end_time":{"type":"string","description":"End time"},"cron_expr":{"type":"string","description":"crontab string, e.g.:\nEvery day at 00:01 = 1 0 * * *\nEvery month on 1st at 02:03 = 3 2 1 * *\nEvery Tuesday at 01:02 = 2 1 * * 2"},"active":{"type":"boolean","description":"Whether the task is active"},"time_zone":{"type":"string","description":"Time zone, e.g., Asia/Shanghai"},"recipients":{"type":"string","description":"Recipient emails; multiple emails separated by semicolon"},"last_run_time":{"type":"string","format":"date-time","description":"The timestamp of the most recent execution of the report job."}}},{"type":"object","properties":{"params":{"allOf":[{"type":"object","properties":{"ring_group":{"type":"array","items":{"type":"string"},"description":"List of ring groups.\n"}}},{"type":"object","required":["from","to","time_range"],"properties":{"from":{"type":"string","description":"Start time."},"to":{"type":"string","description":"End time."},"time_range":{"type":"string","description":"Time range preset.","enum":["TODAY","YESTERDAY","LAST_WEEK","LAST_SEVEN_DAYS","LAST_MONTH","LAST_THIRTY_DAYS","CUSTOM"]}}}]}}}],"required":["type"],"title":"Ring Group Performance"}}}}
```

## The report\_speed\_of\_accept object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"report_speed_of_accept":{"allOf":[{"type":"object","properties":{"id":{"allOf":[{"type":"string"}],"description":"The unique ID of report.","readOnly":true},"type":{"type":"string","enum":["ABANDONDELAY","AGENTDETAILSACTIVITY","AGENTNOTREADYCODE","AGENTQUEUEREPORT","AGENTSUMMARYACTIVITY","CALLBACKSUMMARY","CALLLOGS","DAILYSTATISTICS","QUEUESUMMARY","RINGGROUPPERFORMANCE","SPEEDOFACCEPT","USERSTATISTICS"],"description":"Report type, string enum."},"format":{"type":"string","description":"Report file format:CSV、HTML","enum":["CSV","HTML"]},"schedule_name":{"type":"string","description":"Report Job name"},"create_time":{"type":"string","format":"date-time","description":"The timestamp when the report log entry was created."},"start_time":{"type":"string","description":"Start time; task will not run before this time"},"end_time":{"type":"string","description":"End time"},"cron_expr":{"type":"string","description":"crontab string, e.g.:\nEvery day at 00:01 = 1 0 * * *\nEvery month on 1st at 02:03 = 3 2 1 * *\nEvery Tuesday at 01:02 = 2 1 * * 2"},"active":{"type":"boolean","description":"Whether the task is active"},"time_zone":{"type":"string","description":"Time zone, e.g., Asia/Shanghai"},"recipients":{"type":"string","description":"Recipient emails; multiple emails separated by semicolon"},"last_run_time":{"type":"string","format":"date-time","description":"The timestamp of the most recent execution of the report job."}}},{"type":"object","properties":{"params":{"allOf":[{"type":"object","properties":{"stx":{"type":"array","items":{"type":"integer","minimum":1,"maximum":3600},"minItems":10,"maxItems":10,"description":"Accepted Agent ST1-ST10 configuration.\nThis array contains exactly 10 integer values.\nValid range for each value is 1-3600 seconds.\n**Values must be in ascending order (ST1 < ST2 < … < ST10).**\n"}}},{"type":"object","required":["from","to","time_range"],"properties":{"from":{"type":"string","description":"Start time."},"to":{"type":"string","description":"End time."},"time_range":{"type":"string","description":"Time range preset.","enum":["TODAY","YESTERDAY","LAST_WEEK","LAST_SEVEN_DAYS","LAST_MONTH","LAST_THIRTY_DAYS","CUSTOM"]}}},{"type":"object","required":["queue"],"properties":{"queue":{"type":"array","items":{"type":"string","description":"Queue number."}}}}]}}}],"title":"Speed Of Accept"}}}}
```

## The report\_user\_statistics object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"report_user_statistics":{"allOf":[{"type":"object","properties":{"id":{"allOf":[{"type":"string"}],"description":"The unique ID of report.","readOnly":true},"type":{"type":"string","enum":["ABANDONDELAY","AGENTDETAILSACTIVITY","AGENTNOTREADYCODE","AGENTQUEUEREPORT","AGENTSUMMARYACTIVITY","CALLBACKSUMMARY","CALLLOGS","DAILYSTATISTICS","QUEUESUMMARY","RINGGROUPPERFORMANCE","SPEEDOFACCEPT","USERSTATISTICS"],"description":"Report type, string enum."},"format":{"type":"string","description":"Report file format:CSV、HTML","enum":["CSV","HTML"]},"schedule_name":{"type":"string","description":"Report Job name"},"create_time":{"type":"string","format":"date-time","description":"The timestamp when the report log entry was created."},"start_time":{"type":"string","description":"Start time; task will not run before this time"},"end_time":{"type":"string","description":"End time"},"cron_expr":{"type":"string","description":"crontab string, e.g.:\nEvery day at 00:01 = 1 0 * * *\nEvery month on 1st at 02:03 = 3 2 1 * *\nEvery Tuesday at 01:02 = 2 1 * * 2"},"active":{"type":"boolean","description":"Whether the task is active"},"time_zone":{"type":"string","description":"Time zone, e.g., Asia/Shanghai"},"recipients":{"type":"string","description":"Recipient emails; multiple emails separated by semicolon"},"last_run_time":{"type":"string","format":"date-time","description":"The timestamp of the most recent execution of the report job."}}},{"type":"object","properties":{"params":{"allOf":[{"type":"object","properties":{"extension_number":{"type":"string","description":"Extension number"}}},{"type":"object","required":["from","to","time_range"],"properties":{"from":{"type":"string","description":"Start time."},"to":{"type":"string","description":"End time."},"time_range":{"type":"string","description":"Time range preset.","enum":["TODAY","YESTERDAY","LAST_WEEK","LAST_SEVEN_DAYS","LAST_MONTH","LAST_THIRTY_DAYS","CUSTOM"]}}},{"type":"object","required":["status","direction"],"properties":{"status":{"type":"string","description":"Call status.\n","enum":["NONE","ANSWERED","UNANSWERED"]},"direction":{"type":"string","description":"Call direction type, indicating the routing path of the call.","enum":["NONE","INBOUND","OUTBOUND","INTERNAL"]}}}]}}}],"title":"User Statistics"}}}}
```

## The id-59 object

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"components":{"schemas":{"id-59":{"allOf":[{"type":"string"}],"description":"The unique ID of the not ready code.\n"}}}}
```
