Chat Transcripts

Intro

Clients may want to download a chat transcript in a printer-friendly format. For this purpose, MedChat provides an endpoint to retrieve a PDF version of any chat.

Authentication

Service clients may consume the API using an authorization token. This token grants service access to your organization's data.

📘

If using OAuth 2.0 to obtain an access token, the requested scopes must include 'externalchat-api'. This does not apply to services using the Authorization Token process referenced above.

Time Zones

The rendered PDF will translate all timestamps into a specified time zone. The time zone identifier is required and must be one of the following IANA identifiers for US time zones:

Pacific/Honolulu
America/Adak
America/Anchorage
America/Juneau
America/Sitka
America/Metlakatla
America/Yakutat
America/Nome
America/Los_Angeles
America/Phoenix
America/Denver
America/Boise
America/Chicago
America/Indiana/Tell_City
America/Indiana/Knox
America/Menominee
America/North_Dakota/Center
America/North_Dakota/New_Salem
America/North_Dakota/Beulah
America/New_York
America/Detroit
America/Kentucky/Louisville
America/Kentucky/Monticello
America/Indiana/Indianapolis
America/Indiana/Vincennes
America/Indiana/Winamac
America/Indiana/Marengo
America/Indiana/Petersburg
America/Indiana/Vevay

Endpoint

Requests to download a PDF chat transcript should be made to https://medchatapp.com/livechatapi/orgs/{orgId}/chats/{chatId}/transcript?timeZoneId={timeZoneId}. The Accept header should be set to 'application/vnd.medchat+json;v=1.0'.