Skip to content

Firestore Collection Feedback

Felix Beil edited this page Apr 28, 2020 · 2 revisions
Name feedback
Context database root
Document IDs auto generated

The feedback collection stores feedback that has been given via the bot. The name of the documents are auto generated by firebase.

Document structure

Each document contains the information about a single feedback recording. It has the following fields.

  • phone_number (string)
    The complete phone number of the caller that gave the feedback. The phone number has to be interntationally valid and thus has to include the country based prefix.
  • timestamp (timestamp)
    The timestamp at which the feedback was recorded.
  • recording (map)
    The recording map contains all information about the recording itself.
    • duration (number)
      The duration of the recording in seconds.
    • url (string)
      The url at which the recording can be found.
  • locale (string) The ISO 3166-1 alpha-2 country code (in lower case) of the country that the feedback has been recorded in.

Example

An exampe document /feedback/AbCDEfgh1j43mNOp0rst for a feed back recorded by the german bot could look like this (JSON represenation of the data):

{
  "phone_number": "+49123456789",
  "timestamp": 2020-04-01 22:45:03,
  "recording": {
  	"duration": 21.4,
  	"url": "https://api.twilio.com/machbarschaft/recording.mp3"
  },
  "locale": "de"
}
Clone this wiki locally