Model: HelplineV1

1 min

Model Parameters

HelplineV1
- idstringrequired
  Example
  crisis-text-line
  Description
  The unique identifier for the helpline.
- namestringrequired
  Example
  Crisis Text Line
  Description
  Official name of the helpline in the native language.
- descriptionstring
  Example
  Crisis Text Line is here to help you, whatever you're going through. We provide 24/7, free and confidential support and information by text message (text HOME to 741-741), online chat and WhatsApp (+1-443-787-7678). We are available to talk with you about any kind of experience relating to mental health, including anxiety, depression, self-harm, stress, and thoughts of suicide.
  Description
  Description of the service provided by the helpline in English.
- shortDescriptionstring
  Example
  24/7 free crisis support for youth in NZ
  Description
  A concise summary of the service provided by the helpline in English.
- websitestring<uri>
  Example
  https://www.crisistextline.org/
  Description
  Primary website of the service.
  Format
  uri
- countryobjectrequired
  - Country
    - namestringrequired
      Example
      New Zealand
      Description
      English language name for the country.
    - codestringrequired
      Example
      nz
      Description
      ISO 3166 Alpha-2 code for the country.
    - emergencyNumberstring
      Example
      111
      Description
      Emergency services phone number. Only available for countries where suicide is not a illegal.
- timezonestringrequired
  Example
  America/Los_Angeles
  Description
  The timezone where this helpline operates.
- topicsstring[]required
  Description
  A collection of topics which the helpline supports.
- supported_languagesstring[]required
  Example
```
[
  "en",
  "es",
  "fr"
]
```
  Description
  A collection of ISO language codes that the helpline supports.
- specialtiesstring[]required
  Description
  Specialties categorize services by audience demographics, identity groups, and specific service needs.
- supportTypesstring[]
  Description
  A collection listing the qualification of the people who provide support at the helpline. e.g. Counselors, Volunteers, Peers, etc. Only available for Full tier applications
- hoursobject
  - Hours
    - alwaysOpenbooleanrequired
      Description
      Indicates if the helpline is always open. If true, the periods field will be empty. If false, the periods field will contain the opening hours for the helpline.
    - periodsPeriod[]required
      Description
      A collection of periods representing the opening hours for the helpline. Only available if always_open is false.
      - dayinteger<int32>required
        Example
        1
        Description
        An integer representation of the day of the week that the period applies to. Days are index from 1, with Monday=1, Tuesday=2, through to Sunday=7.
        Format
        int32
      - openstring<time>required
        Example
        09:00
        Description
        The time the helpline opens on the given day.
        Format
        time
      - closestring<time>required
        Example
        17:00
        Description
        The time the helpline closes on the given day.
        Format
        time
- phoneNumberstring
  Example
  1-800-555-1212
  Description
  Phone number that people in crisis can call.
- smsNumberstring
  Example
  741741
  Description
  SMS number that people in crisis can txt.
- webChatUrlstring<uri>
  Example
  https://connect.crisistextline.org/chat?utm_source=findahelpline
  Description
  URL that people in crisis can use to start an online chat.
  Format
  uri
- whatsappUrlstring<uri>
  Example
  https://wa.me/1-800-555-1212
  Description
  WhatsApp URL that people in crisis can use to start a WhatsApp chat.
  Format
  uri

HelplineV1 model