Push pdf transcripts from past number of {days} to your organizations SFTP.
For information on SFTP configuration, learn more from this guide.
| Service Name | Push Updated Transcript |
| Service Type | REST |
| Method | PUT |
| UAT (Sandbox) URL |
https://integration.uat.marley.ai/api/case/actions/push-updated-transcripts/{days} |
| Production URL | https://integration.himarley.io/api/case/actions/push-updated-transcripts/{days} |
| Technical Documentation | View technical documentation with sample request and response payloads hosted on Postman. |
Table of Contents
API Request
Flow
- Send API request with the path parameter of the number of days and optional requestBody.
- The number specified will be from the date of the request. For example, if 3 is passed in the request, then the last 3 days of transcripts from the date of the request will be pushed to Hi Marleys SFTP site.
- In the request body, specify the:
- pgpKey -
BASE64_PGP_KEY_FOR_OPTIONAL_ENCRYPTION -
format (example)-
${caseData.brand}/${caseData.claimNumber}_${caseData.id} - redacted - true or false
- pgpKey -
- Hi Marley receives the request and retrieves the pushes the transcripts to Hi Marleys SFTP site for the specified number of days.
- Hi Marley responds with - "status": "Started upload", bulkActionId, and array of caseIds.
- The transcript/s are uploaded to the customer folder on Hi Marleys SFTP site.
Request Example
https://integration.uat.marley.ai/api/case/actions/push-updated-transcripts/3
Request Path Breakdown
| Property | Description |
Type |
Required | Example |
| days |
The number of days (from today) you want to push transcripts to Hi Marleys SFTP. |
int |
true |
3 |
Request Body Breakdown
| Property | Description |
Type |
Required | Example |
| pgpKey |
Base64 encoded Public pgpKey to encrypt transcripts. |
string |
false |
"pgpKey":"LS0tLS1CRUdJTiBQR1AgUFVCTElDIEtFWSBCTE9DS
y0tLS0tDQ0KVmVyNCdmREaW9yNFJRVk5MWkNBWg0NClZPTXVacGN
KaFFLdm45YVppcGlNDQowTmN3dGg0cVhOZFkrdGJfjkdlsafjkdlafdjkls
afdafdsafdsw1UE1pKdmc0NjR3RXFqV28rV3FjMnBydW1zVDZnYmpidA
0NCnJGd2ZLTFk5dWZwQWhaYVBiRkYrcm94K3RhSWZZMGNDOHN6Nz
B4aTRnTTNaajRoakVK2cUU0YklQRnZ1YVVOak1RQw0NCm1XZ1Y1QUlp
eTNHRzk2ZUJwQ3Z6QM29PQUFDZ2tRWjlSREVMQVVxNTdhK3dDZmQ4"
|
| format |
The filename/format of the file location and title based on Hi Marley tokens.
Available Filename Format Templates documentation. |
string |
false |
"format":"{caseData.brand}/${caseData.claimNumber}_${caseData.id}"
|
| redacted |
If set to true, redaction is applied to sensitive values within the transcript such as SSN & bank account numbers. Omitting this field will default to the organizations redaction setting. |
boolean |
false |
"redacted": true
|
API Response
Response Payload Example
{
"status": "Started upload",
"bulkActionId": "12673cd0-12fe-4a66-bb01-aee76b1119d9",
"caseIds": [
"8f4acac7-9e77-4cc6-a2a9-e18dfae3jnv3",
"0bd4bcd7-c7cd-4124-baa0-66982734lk98",
"0bd4bcd7-c7cd-4124-baa0-6698273vd0m2"
]
}
Response Fields Breakdown
| Property | Element | Description | Type | Required | Example |
|
status |
The status of the transcript upload for the associated case in the API request. Note, the status will be 'started upload' even when a file has successfully been uploaded. |
string |
true |
"status": "Started upload" | |
| bulkActionId |
The identifier assigned to the bulk action, which in this case is upload of transcripts. |
string |
true |
"bulkActionId": "12673cd0-12fe-4a66-bb01-aee76b1119d9" | |
| caseIds |
An array of the Case ID associated with the Hi Marley Case for which the upload of transcripts occurred. |
string |
true |
"caseIds": [ "8f4acac7-9e77-4cc6-a2a9-e18dfae3jnv3", "0bd4bcd7-c7cd-4124-baa0-66982734lk98", "0bd4bcd7-c7cd-4124-baa0-6698273vd0m2" ] |
Comments
0 comments
Please sign in to leave a comment.