Retrieve call recordings by passing 'TransactionId' using Send Message API v2.
API Endpoint & Postman Collection
Voice channel is supported via Voice API and Send Message API v2.
API endpoint for it is: [https://{YourRegion}.webexconnect.io/v2/recordings/flow/{transactionId}].
Please modify YourRegion in the URL to reflect your tenant’s region. See Know Your Endpoint Page.
Refer to our Postman Collection for trying Get Voice Call Recording Using Send Message API v2.
API Response and Error Codes
Send Message API v2 is asynchronous. You receive a HTTP response when your request is accepted. Further processing details are sent to your notify URL. See Channel Specific Status Codes for more information.
Request Body for Get Voice Call Recordings API
curl --location 'https://{baseURL}/v2/recordings/flow/{TransactionId}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'key: ServiceKey'
Get Voice Call Recordings Path Parameters
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| TransactionId | string | yes | Unique identifier for the call transaction. Returned in the response body of events. |
Get Voice Call Recordings Header Parameters
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| key | string | yes | Authorization token (this can be either a JWT signed by a secret key or the service key). |
Sample Response Body
{
"clientId": 3678,
"recordings": [
{
"recordingDuration": "7",
"recordingName": "timestamp_c7751df7-d324-XXXX-XXXX-df1cd52d5194_9.wav",
"recordingFilePath": "https://anydomain.imiconnect.co/voice-recordings/timestamp_c7751df7-d324-XXXX-9fe7-df1cd52d5194_9.wav"
}
],
"groupId": 4123,
"teamId": 4321,
"messageId": "80875ee5-2567-XXXX-XXXX-48cf96ce96e3_20758_12XXXX"
}
Response Parameters
| Parameter | Description |
|---|---|
| clientId | Unique ID of the client (tenant backend ID). |
| recordings | JSON object with details about the recordings. |
| recordingDuration | Duration of the recording in seconds. |
| recordingName | Name of the recording file. |
| recordingFilePath | Storage path of the recording file. |
| groupId | Identifier for the group the team belongs to. |
| teamId | Identifier for the team associated with the service key. |
| messageId | Unique message ID for the transaction, returned in the response. |