Call Recording - Start Recording
Indítsa el a hívás rögzítését.
POST {endpoint}/calling/recordings?api-version=2025-05-15
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
endpoint
|
path | True |
string (url) |
Az Azure Communication-erőforrás végpontja. |
api-version
|
query | True |
string |
A meghívandó API verziója. |
Kérelem fejléce
Name | Kötelező | Típus | Description |
---|---|---|---|
Authorization | True |
string |
Egy Azure Communication Services felhasználói hozzáférési jogkivonat. |
Repeatability-Request-ID |
string (uuid) |
Ha meg van adva, az ügyfél azt irányítja, hogy a kérés megismételhető legyen; vagyis az ügyfél többször is végrehajthatja a kérést ugyanazzal az ismétlhetőséggel–Request-Id és a megfelelő választ kaphatja vissza anélkül, hogy a kiszolgáló többször hajtja végre a kérést. Az ismétlődésRequest-Id értéke egy átlátszatlan sztring, amely a kérelem ügyfél által létrehozott egyedi azonosítóját jelöli. Ez egy 4-es verziójú (véletlenszerű) UUID. |
|
Repeatability-First-Sent |
string (date-time-rfc1123) |
Ha az ismételhetőségRequest-ID fejléc van megadva, akkor az Ismételhetőség-First-Sent fejlécet is meg kell adni. Az értéknek a kérelem első létrehozásának dátuma és időpontja kell, hogy legyen, a HTTP-dátum IMF-fixdátum formájában kifejezve. Példa: V, 06 Nov 1994 08:49:37 GMT. |
Kérelem törzse
Name | Kötelező | Típus | Description |
---|---|---|---|
callLocator | True |
A híváskereső. |
|
audioChannelParticipantOrdering |
Communication |
Az a sorrend, amelyben a hangcsatornák hozzá vannak rendelve a nem kevert felvétel résztvevőihez. Ha a "recordingChannelType" értéke "unmixed", és az "audioChannelParticipantOrdering" nincs megadva, a rendszer automatikusan hozzárendeli a résztvevőhöz tartozó hangcsatornát az első hang észlelésének sorrendje alapján. A csatorna és a résztvevő leképezésének részletei a felvétel metaadataiban találhatók. |
|
channelAffinity |
A hívásrögzítés csatorna affinitása Ha a "recordingChannelType" értéke "nincs keverve", ha a channelAffinity nincs megadva, a rendszer automatikusan hozzárendeli a csatornát. Channel-Participant leképezés részletei a felvétel metaadataiban találhatók. /// |
||
externalStorage |
Nem kötelező tulajdonság a rögzítés tárolási helyének megadásához |
||
pauseOnStart |
boolean |
Ha igaz értékre van állítva, szüneteltetés módban kezdi meg a felvételt, amely folytatható. |
|
recordingChannelType |
A hívásrögzítés csatornatípusa. |
||
recordingContentType |
A hívásrögzítés tartalomtípusa. |
||
recordingFormatType |
A hívásrögzítés formátuma. |
||
recordingStateCallbackUri |
string |
Az értesítések küldéséhez használandó uri. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
A hívásindítási felvétel válaszát adja vissza. |
|
Other Status Codes |
Communication |
Hiba |
Biztonság
Authorization
Egy Azure Communication Services felhasználói hozzáférési jogkivonat.
Típus:
apiKey
In:
header
Példák
CallRecording_StartRecording
Mintakérelem
POST https://contoso.communications.azure.com/calling/recordings?api-version=2025-05-15
{
"recordingStateCallbackUri": "https://contoso.communications.azure.com/callback",
"recordingContentType": null,
"recordingChannelType": null,
"recordingFormatType": null,
"pauseOnStart": true,
"externalStorage": {
"recordingStorageKind": "azureBlobStorage",
"recordingDestinationContainerUrl": "https://contoso.blob.core.windows.net/recordings"
},
"callLocator": {
"serverCallId": "aHR0cHM6Ly9za3lwZS5uZXQvYXBpL3YyL2NwL3NreXBlLm5ldC9jb252LzFQd3ZKMTcxZFI/aT0wJmU9NzU3NzA4NzU3OQ==",
"kind": "serverCallLocator"
}
}
Mintaválasz
{
"recordingId": "eyJQbGF0Zm9ybUVuZHBvaW50SWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUiLCJSZXNvdXJjZVNwZWNpZmljSWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUifQ==",
"recordingState": "inactive",
"recordingKind": "teamsCompliance"
}
Definíciók
Name | Description |
---|---|
Call |
A híváshoz való csatlakozáshoz vagy művelethez használt lokátor |
Call |
A híváskereső típusa. |
Channel |
Csatorna affinitása egy résztvevőhöz |
External |
|
Recording |
A hívásrögzítés csatornatípusa. |
Recording |
A hívásrögzítés tartalomtípusa. |
Recording |
A hívásrögzítés formátuma. |
Recording |
|
Recording |
|
Recording |
|
Recording |
Meghatározza a külső tároló fajtáját |
Start |
A kérelem hasznos adatai a hívásrögzítési művelethez kezdődnek a híváskeresővel. |
CallLocator
A híváshoz való csatlakozáshoz vagy művelethez használt lokátor
Name | Típus | Description |
---|---|---|
groupCallId |
string |
A csoport hívásazonosítója |
kind |
A híváskereső típusa. |
|
roomId |
string |
Az Acs szoba azonosítója (a Felvétel indítása nem támogatott) |
serverCallId |
string |
A kiszolgáló hívásazonosítója. |
CallLocatorKind
A híváskereső típusa.
Érték | Description |
---|---|
groupCallLocator | |
roomCallLocator | |
serverCallLocator |
ChannelAffinity
Csatorna affinitása egy résztvevőhöz
Name | Típus | Description |
---|---|---|
channel |
integer (int32) minimum: 0maximum: 4 |
Csatornaszám, amelyre egy adott résztvevőtől származó bitfolyam lesz megírva. |
participant |
Communication |
ExternalStorage
Name | Típus | Description |
---|---|---|
recordingDestinationContainerUrl |
string (uri) |
Tároló vagy tárolón belüli hely URI-ja |
recordingStorageKind |
Meghatározza a külső tároló fajtáját |
RecordingChannelType
A hívásrögzítés csatornatípusa.
Érték | Description |
---|---|
mixed | |
unmixed |
RecordingContentType
A hívásrögzítés tartalomtípusa.
Érték | Description |
---|---|
audio | |
audioVideo |
RecordingFormatType
A hívásrögzítés formátuma.
Érték | Description |
---|---|
mp3 | |
mp4 | |
wav |
RecordingKind
Érték | Description |
---|---|
azureCommunicationServices | |
teams | |
teamsCompliance |
RecordingState
Érték | Description |
---|---|
active | |
inactive |
RecordingStateResponse
Name | Típus | Description |
---|---|---|
recordingId |
string |
|
recordingKind | ||
recordingState |
RecordingStorageKind
Meghatározza a külső tároló fajtáját
Érték | Description |
---|---|
azureBlobStorage | |
azureCommunicationServices |
StartCallRecordingRequest
A kérelem hasznos adatai a hívásrögzítési művelethez kezdődnek a híváskeresővel.
Name | Típus | Description |
---|---|---|
audioChannelParticipantOrdering |
Communication |
Az a sorrend, amelyben a hangcsatornák hozzá vannak rendelve a nem kevert felvétel résztvevőihez. Ha a "recordingChannelType" értéke "unmixed", és az "audioChannelParticipantOrdering" nincs megadva, a rendszer automatikusan hozzárendeli a résztvevőhöz tartozó hangcsatornát az első hang észlelésének sorrendje alapján. A csatorna és a résztvevő leképezésének részletei a felvétel metaadataiban találhatók. |
callLocator |
A híváskereső. |
|
channelAffinity |
A hívásrögzítés csatorna affinitása Ha a "recordingChannelType" értéke "nincs keverve", ha a channelAffinity nincs megadva, a rendszer automatikusan hozzárendeli a csatornát. Channel-Participant leképezés részletei a felvétel metaadataiban találhatók. /// |
|
externalStorage |
Nem kötelező tulajdonság a rögzítés tárolási helyének megadásához |
|
pauseOnStart |
boolean |
Ha igaz értékre van állítva, szüneteltetés módban kezdi meg a felvételt, amely folytatható. |
recordingChannelType |
A hívásrögzítés csatornatípusa. |
|
recordingContentType |
A hívásrögzítés tartalomtípusa. |
|
recordingFormatType |
A hívásrögzítés formátuma. |
|
recordingStateCallbackUri |
string |
Az értesítések küldéséhez használandó uri. |