Request Parameter
Parameter Name | Data Type | Description | Required/ Optional |
|---|---|---|---|
audioFile | File | Recording of the conversation in .WAV format. Currently, only.WAV files are supported. | Required |
metaData | Text | JSON request body including the conversation metadata as described below. NoteThe metadata parameters provided are samples and may vary for each customer. | Required |
metadata: sessionId | String | Your unique Id of the conversation provided by the Organization/customer. | Required |
metadata: conversationRecordedDateTime | Date | The date and time of the recording in Epoch Timestamp format. | Required |
metadata: orgHierarchyId | String | Node Id of the Organization Hierarchy. To obtain orgHierarchyId , refer Create Organization and Organization Hierarchy section. | Required |
metadata: direction | Text | Direction of the call. Example: Inbound, Outbound. | Required |
metadata: isLeftChannelAgent | Boolean | If set to True then the conversation from the Left Channel is Agent. The first speaker in the transcript is the Agent. | Required |
metadata: isTestConversation | Boolean | If set to True, the conversation will appear for validation in the Conversation Fact page. | Optional |
metadata: language | String | Language of the conversation. Currently supports US English (en-us) only. | Required |
metadata: conversationType | String | Channel of the conversation. Currently supports Voice only. | Required |
participants: name | String | Name of the participant involved in the conversation. | Required |
participants: id | Number | Id of the participant. | Required |
participants: number | Number | Participant’s contact number used in the conversation. | Optional |
participants: role | String | Role of the participant. Example: Agent, Customer | Required |
participants: mailId | String | Email Id of the participant. Required for participant with Agent role. | Required |
auxiliaryMetaData | String | Includes a list of specific information related to the call such as call_id, product_type, reason_for_call and more. This data varies for each customer based on the nature of the call. | Required |