Calls: e-mail transcript

E-mails a chat transcript.

Authentication

LibraryH3lp supports cookie-based authentication. To learn more, you can read the details on authentication.

HTTP and HTTPS

Requests are served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.

URI

/2011-12-03/queues/{QueueName}/calls/{GuestJid}/{ConversationId}/mail

HTTP GET

Not supported.

HTTP POST

E-mails the transcript for the call to a specified recipient.

Required Parameters

You must POST using the following parameter:

Parameter	Description
email	String containing the e-mail address of the transcript recipient.

Optional Parameters

You may POST using the following parameter:

Parameter	Description
timezone	String containing a time zone to use for time stamps in the transcript. Read more about time zones within LibraryH3lp.

Response

Returns a JSON response with the following properties:

Property	Description
success	Boolean indicating if the request was successful.
message	Optional. If success is null, message is a string describing the reason for the failed request.

Example

POST /2011-12-03/queues/example-queue/calls/5189487901334778072897@libraryh3lp.com/1790260/mail
Note: POST is URL decoded above for clarity.

{
  "success": true
}

HTTP PUT

Not supported.

HTTP DELETE

Not supported.