-
Notifications
You must be signed in to change notification settings - Fork 250
/
Copy pathazure.communication.callautomation.CallConnectionProperties.yml
132 lines (127 loc) · 5.88 KB
/
azure.communication.callautomation.CallConnectionProperties.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
### YamlMime:PythonClass
uid: azure.communication.callautomation.CallConnectionProperties
name: CallConnectionProperties
fullName: azure.communication.callautomation.CallConnectionProperties
module: azure.communication.callautomation
summary: Detailed properties of the call.
constructor:
syntax: 'CallConnectionProperties(*, call_connection_id: str | None = None, server_call_id:
str | None = None, targets: List[CommunicationIdentifier] | None = None, call_connection_state:
str | CallConnectionState | None = None, callback_url: str | None = None, media_streaming_subscription:
MediaStreamingSubscription | None = None, transcription_subscription: TranscriptionSubscription
| None = None, source_caller_id_number: PhoneNumberIdentifier | None = None, source_display_name:
str | None = None, source: CommunicationIdentifier | None = None, correlation_id:
str | None = None, answered_by: CommunicationUserIdentifier | None = None, answered_for:
PhoneNumberIdentifier | None = None)'
keywordOnlyParameters:
- name: call_connection_id
description: The call connection id of this call leg.
types:
- <xref:str>
- name: server_call_id
description: The server call id of this call.
types:
- <xref:str>
- name: targets
description: The targets of the call when the call was originally initiated.
types:
- <xref:list>[<xref:azure.communication.callautomation.CommunicationIdentifier>]
- name: call_connection_state
description: The state of the call.
types:
- <xref:str>
- <xref:azure.communication.callautomation.CallConnectionState>
- name: callback_url
description: The callback URL.
types:
- <xref:str>
- name: media_streaming_subscription
description: media_streaming_subscription for media streaming.
types:
- <xref:azure.communication.callautomation.MediaStreamingSubscription>
- name: transcription_subscription
description: transcription_subscription for transcription.
types:
- <xref:azure.communication.callautomation.TranscriptionSubscription>
- name: source_caller_id_number
description: 'The source caller Id, a phone number, that''s shown to the
PSTN participant being invited.
Required only when calling a PSTN callee.'
types:
- <xref:azure.communication.callautomation.PhoneNumberIdentifier>
- name: source_display_name
description: Display name of the call if dialing out.
types:
- <xref:str>
- name: source
description: Source identity of the caller.
types:
- <xref:azure.communication.callautomation.CommunicationIdentifier>
- name: correlation_id
description: Correlation ID of the call
types:
- <xref:str>
- name: answered_by
description: The identifier that answered the call
types:
- <xref:azure.communication.callautomation.CommunicationUserIdentifier>
- name: answered_for
description: 'Identity of the original Pstn target of an incoming Call. Only populated
when the original target is a Pstn number.'
types:
- <xref:azure.communication.callautomation.PhoneNumberIdentifier>
attributes:
- uid: azure.communication.callautomation.CallConnectionProperties.answered_by
name: answered_by
summary: The identifier that answered the call
signature: 'answered_by: CommunicationIdentifier | None'
- uid: azure.communication.callautomation.CallConnectionProperties.answered_for
name: answered_for
summary: The phone identifier that answered the call
signature: 'answered_for: PhoneNumberIdentifier | None'
- uid: azure.communication.callautomation.CallConnectionProperties.call_connection_id
name: call_connection_id
summary: The call connection id of this call leg.
signature: 'call_connection_id: str | None'
- uid: azure.communication.callautomation.CallConnectionProperties.call_connection_state
name: call_connection_state
summary: The state of the call.
signature: 'call_connection_state: str | CallConnectionState | None'
- uid: azure.communication.callautomation.CallConnectionProperties.callback_url
name: callback_url
summary: The callback URL.
signature: 'callback_url: str | None'
- uid: azure.communication.callautomation.CallConnectionProperties.correlation_id
name: correlation_id
summary: Correlation ID of the call
signature: 'correlation_id: str | None'
- uid: azure.communication.callautomation.CallConnectionProperties.media_streaming_subscription
name: media_streaming_subscription
summary: Media streaming subscription.
signature: 'media_streaming_subscription: MediaStreamingSubscription | None'
- uid: azure.communication.callautomation.CallConnectionProperties.server_call_id
name: server_call_id
summary: The server call id of this call.
signature: 'server_call_id: str | None'
- uid: azure.communication.callautomation.CallConnectionProperties.source
name: source
summary: Source identity of the caller.
signature: 'source: CommunicationIdentifier | None'
- uid: azure.communication.callautomation.CallConnectionProperties.source_caller_id_number
name: source_caller_id_number
summary: 'The source caller Id, a phone number, that''s shown to the
PSTN participant being invited.
Required only when calling a PSTN callee.'
signature: 'source_caller_id_number: PhoneNumberIdentifier | None'
- uid: azure.communication.callautomation.CallConnectionProperties.source_display_name
name: source_display_name
summary: Display name of the call if dialing out.
signature: 'source_display_name: str | None'
- uid: azure.communication.callautomation.CallConnectionProperties.targets
name: targets
summary: The targets of the call when the call was originally initiated.
signature: 'targets: List[CommunicationIdentifier] | None'
- uid: azure.communication.callautomation.CallConnectionProperties.transcription_subscription
name: transcription_subscription
summary: Transcription subscription.
signature: 'transcription_subscription: TranscriptionSubscription | None'