---
title: "phone"
url: "https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84/schemas/phone"
---

> Full API specification: https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84.md

# phone

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Zinnia Policy Transactions API.
  version: 1.0.8
servers:
  - url: https://dev.api.zinnia.io
    description: DEV Environment
  - url: https://qa.api.zinnia.io
    description: QA Environment
components:
  schemas:
    phone:
      type: object
      properties:
        startDate:
          type: string
          format: date
          pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})
          description: Date (with pattern "yyyy-mm-dd")
        endDate:
          type: string
          format: date
          pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})
          description: Date (with pattern "yyyy-mm-dd").If provided by the user, the
            system will apply an end date to the phone number, ensuring that a
            new phone number is not generated.
        phoneType:
          type: string
          enum:
            - MOBILE
            - HOME
            - BUSINESS
            - CLAIMCENTER
            - CUSTOMERSERVICE
            - CORPORATEOFFICE
            - FAX
            - OTHER
          description: Phone type
        countryCode:
          type: string
          example: "011"
          description: Country code
        areaCode:
          type: string
          example: "973"
          description: Area code
        dialNumber:
          type: string
          example: "765789"
          description: Dial number
        extension:
          type: string
          example: "null"
          description: Extension
        bestTime:
          type: string
          example: "null"
          description: Best time
        timezone:
          type: string
          example: "null"
          description: Timezone for the entered phone details
      required:
        - startDate
        - phoneType
        - countryCode
        - dialNumber
```
