Model: ContactMethod

1 min

Model Parameters

ContactMethod
- typestring<phone | sms | onlineChat | whatsapp | tty | reportingForm>required
  Example
  phone
  Description
  The kind of contact method.
  Allowed
  phonesmsonlineChatwhatsappttyreportingForm
- valuestringrequired
  Example
  1-800-273-8255
  Description
  The value used to reach the helpline by this contact method (e.g. phone number or chat URL).
- accessibilityNotesstring
  Description
  Optional notes about the accessibility of this contact method.
- alwaysOpenbooleanrequired
  Description
  Indicates if this contact method is always available. When true, openingHours will be empty.
- openingHoursOpeningSpan[]required
  Description
  Opening periods for this contact method with overlapping and adjacent periods merged and resolved to the helpline's timezone. Empty when alwaysOpen is true. null when the application's API tier does not permit access to opening hours.
  - localDayOfWeekstring<monday | tuesday | wednesday | thursday | friday | saturday | sunday>required
    Example
    monday
    Description
    Day of the week this period applies to in the helpline's local timezone.
    Allowed
    mondaytuesdaywednesdaythursdayfridaysaturdaysunday
  - openstring<date-time>required
    Example
    2026-04-13T09:00:00+12:00
    Description
    ISO 8601 datetime of the next occurrence of when the helpline opens, in the helpline's timezone.
    Format
    date-time
  - closestring<date-time>required
    Example
    2026-04-13T17:00:00+12:00
    Description
    ISO 8601 datetime of the next occurrence of when the helpline closes, in the helpline's timezone.
    Format
    date-time