API Documentation

Create a transcription

POST/brands/:id/transcriptions

Creates a transcription under the given brand. The optional contact and deal must belong to the same brand, and audio must reference an accessible uploaded file. The contents array may be empty, but every entry must include text. Including summary is optional and intended for devices that can produce one on-device.

Body fields:

Example URI

{
  "contact": "d00682a9-2de7-4f43-bb20-20928e760c5f",
  "contents": [
    {
      "timestamp": 0,
      "author": "Agent",
      "text": "Hi, how can I help you?"
    },
    {
      "timestamp": 3.5,
      "author": "Client",
      "text": "Looking for a 3-bedroom house."
    },
    {
      "timestamp": 7.2,
      "author": "Agent",
      "text": "Great, what is your budget?"
    }
  ]
}

{
  "code": "OK",
  "data": {
    "id": "c3f965ed-5ea2-4dde-beb9-e40cb2694478",
    "brand": "6279923f-6c57-4a4f-a2ab-1eeda150d58e",
    "contact": {
      "id": "d00682a9-2de7-4f43-bb20-20928e760c5f",
      "display_name": "Johnny",
      "partner_name": "Jane Doe",
      "brand": "6279923f-6c57-4a4f-a2ab-1eeda150d58e",
      "brand_id": "6279923f-6c57-4a4f-a2ab-1eeda150d58e",
      "user_id": "4a7f3ca2-21ac-4d93-b04f-8e86447f3925",
      "sort_field": "Johnny",
      "last_touch": null,
      "last_touch_action": null,
      "next_touch": null,
      "touch_freq": null,
      "ios_address_book_id": null,
      "android_address_book_id": null,
      "created_at": 1783699193.243914,
      "updated_at": 1783699192.101174,
      "deleted_at": null,
      "created_for": "direct_request",
      "updated_for": "direct_request",
      "deleted_for": null,
      "title": null,
      "first_name": "John",
      "partner_first_name": "Jane",
      "middle_name": "M.",
      "last_name": "Doe",
      "partner_last_name": "Doe",
      "marketing_name": null,
      "nickname": "Johnny",
      "email": "[email protected]",
      "primary_email": "[email protected]",
      "emails": [
        "[email protected]"
      ],
      "parked": false,
      "partner_email": "[email protected]",
      "phone_number": "+989124834198",
      "primary_phone_number": "+989124834198",
      "phone_numbers": [
        "+989124834198"
      ],
      "company": "Rechat",
      "birthday": "1970-01-12T00:00:00.000Z",
      "profile_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
      "cover_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
      "job_title": "Contact Test Subject",
      "source_type": "ExplicitlyCreated",
      "source": null,
      "website": [
        "http://www.gholi.com"
      ],
      "tags": [
        "poo",
        "foo",
        "New"
      ],
      "address": [
        {
          "city": "Dallas",
          "full": "Street, Dallas Texas 72890",
          "name": "Street",
          "type": "stdaddr",
          "extra": "Office",
          "line1": "Street",
          "line2": "Dallas Texas 72890",
          "state": "Texas",
          "country": "US",
          "postcode": "72890"
        }
      ],
      "type": "contact"
    },
    "created_at": 1783699192.101174,
    "updated_at": 1783699192.101174,
    "deleted_at": null,
    "created_by": "4a7f3ca2-21ac-4d93-b04f-8e86447f3925",
    "updated_by": null,
    "summary": null,
    "type": "transcription",
    "entries": [
      {
        "id": "71850133-4f39-48ac-8e69-166810547378",
        "transcription": "c3f965ed-5ea2-4dde-beb9-e40cb2694478",
        "position": 0,
        "timestamp": 0,
        "author": "Agent",
        "text": "Hi, how can I help you?",
        "created_at": 1783699192.101174,
        "deleted_at": null,
        "type": "transcription_entry"
      },
      {
        "id": "d0be5117-7e43-4efa-8088-490442d86de3",
        "transcription": "c3f965ed-5ea2-4dde-beb9-e40cb2694478",
        "position": 1,
        "timestamp": 3.5,
        "author": "Client",
        "text": "Looking for a 3-bedroom house.",
        "created_at": 1783699192.101174,
        "deleted_at": null,
        "type": "transcription_entry"
      },
      {
        "id": "d8a74bb0-25ea-4609-ab7b-0ba4b9d77fec",
        "transcription": "c3f965ed-5ea2-4dde-beb9-e40cb2694478",
        "position": 2,
        "timestamp": 7.2,
        "author": "Agent",
        "text": "Great, what is your budget?",
        "created_at": 1783699192.101174,
        "deleted_at": null,
        "type": "transcription_entry"
      }
    ],
    "text": "Hi, how can I help you?\nLooking for a 3-bedroom house.\nGreat, what is your budget?"
  }
}

Upload transcription audio

POST/brands/:id/transcriptions/audio

Uploads or imports an audio file for later use as audio in POST /brands/:id/transcriptions. Supports multipart uploads, copying an existing file, or importing { url, filename } with common audio extensions such as m4a, mp3, wav, and aac.

Example URI

{
  "code": "OK",
  "data": {
    "id": "77a50f4d-d5b6-42a5-bd30-1f56862a5ab4",
    "created_at": 1783699193.77557,
    "updated_at": 1783699193.775571,
    "deleted_at": null,
    "created_by": "4a7f3ca2-21ac-4d93-b04f-8e86447f3925",
    "path": "transcriptions/6279923f-6c57-4a4f-a2ab-1eeda150d58e/audio/63d047b0-7c78-11f1-93df-b597df6cd6b6.mp3",
    "name": "sample.mp3",
    "public": false,
    "type": "file",
    "url": "https://private-cdn.irish.rechat.com/transcriptions/6279923f-6c57-4a4f-a2ab-1eeda150d58e/audio/63d047b0-7c78-11f1-93df-b597df6cd6b6.mp3?Expires=1783785593780&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=OGkBt5warlGF8umvVNGDW6H6OqMXuiH2oLhzkxQcbaH7Pj1-gp7z0SGr64gll5jSI~1E2kBY08WjubAAZzRu5CdrhPy-XwsaP7a1gbC4HeymooXsHdvaVk7MUf7fF8s2KqYymsTmoxSCA0GIZwM0B-zatRRIGD6I1AD2qNrOCEFoHa~YxX50LL47qjuGjT11LyRSTQoXevemuUx3gR5PDrvezVZJy1iBKPFFqN42cdGYzdo2UQvBewMG4Hx3nhGoa5wNBfynlrAffjOTHcrArDbwilQNBkyY3iT4gj94SRhutghpFlqoYyVDfxqBY3M61ygciIzgP~Iy4tzG4NxhPg__",
    "preview_url": "http://assets.rechat.com/mimes/unknown.png",
    "mime": "audio/mpeg"
  }
}