CallAutomationClient class
Un callAutomationClient representa un cliente al servicio CallAutomation de Azure Communication.
Constructores
Call |
Inicializa una nueva instancia de la clase CallAutomationClient. |
Call |
Inicializa una nueva instancia de la clase CallAutomationClient mediante un TokenCredential o KeyCredential. |
Métodos
answer |
Answer the call (Responder la llamada) |
create |
Cree una llamada saliente de origen a una identidad de destino. |
create |
Cree una llamada saliente desde el origen a un grupo de identidades de destino. |
get |
Inicializa una nueva instancia de CallConnection. |
get |
Inicializa una nueva instancia de CallRecording. |
get |
Obtención de la identidad de origen que se usa para la llamada de creación y respuesta |
redirect |
Redirija la llamada. |
reject |
Rechace la llamada. |
Detalles del constructor
CallAutomationClient(string, CallAutomationClientOptions)
Inicializa una nueva instancia de la clase CallAutomationClient.
new CallAutomationClient(connectionString: string, options?: CallAutomationClientOptions)
Parámetros
- connectionString
-
string
Cadena de conexión para conectarse a un recurso de Azure Communication Service. Ejemplo: "endpoint=https://contoso.eastus.communications.azure.net/;accesskey=secret";
- options
- CallAutomationClientOptions
Opcional. Opciones para configurar la canalización HTTP.
CallAutomationClient(string, TokenCredential | KeyCredential, CallAutomationClientOptions)
Inicializa una nueva instancia de la clase CallAutomationClient mediante un TokenCredential o KeyCredential.
new CallAutomationClient(endpoint: string, credential: TokenCredential | KeyCredential, options?: CallAutomationClientOptions)
Parámetros
- endpoint
-
string
Punto de conexión del servicio (por ejemplo, https://contoso.eastus.communications.azure.net).
- credential
TokenCredential o KeyCredential que se usa para autenticar las solicitudes en el servicio.
- options
- CallAutomationClientOptions
Opcional. Opciones para configurar la canalización HTTP.
Detalles del método
answerCall(string, string, AnswerCallOptions)
Answer the call (Responder la llamada)
function answerCall(incomingCallContext: string, callbackUrl: string, options?: AnswerCallOptions): Promise<CallResult>
Parámetros
- incomingCallContext
-
string
Contexto asociado a la llamada.
- callbackUrl
-
string
Dirección URL de devolución de llamada.
- options
- AnswerCallOptions
Las opciones de solicitud adicionales contienen opciones de api answerCall.
Devoluciones
Promise<CallResult>
createCall(CallInvite, string, CreateCallOptions)
Cree una llamada saliente de origen a una identidad de destino.
function createCall(targetParticipant: CallInvite, callbackUrl: string, options?: CreateCallOptions): Promise<CallResult>
Parámetros
- targetParticipant
- CallInvite
Un único destino.
- callbackUrl
-
string
Dirección URL de devolución de llamada.
- options
- CreateCallOptions
Las opciones de solicitud adicionales contienen opciones de api createCallConnection.
Devoluciones
Promise<CallResult>
createGroupCall(CommunicationIdentifier[], string, CreateCallOptions)
Cree una llamada saliente desde el origen a un grupo de identidades de destino.
function createGroupCall(targetParticipants: CommunicationIdentifier[], callbackUrl: string, options?: CreateCallOptions): Promise<CallResult>
Parámetros
- targetParticipants
Un grupo de identidades de destino.
- callbackUrl
-
string
Dirección URL de devolución de llamada.
- options
- CreateCallOptions
Las opciones de solicitud adicionales contienen opciones de api createCallConnection.
Devoluciones
Promise<CallResult>
getCallConnection(string)
Inicializa una nueva instancia de CallConnection.
function getCallConnection(callConnectionId: string): CallConnection
Parámetros
- callConnectionId
-
string
Identificador callConnection de la instancia de CallConnection. (por ejemplo: 421CONTOSO-cRD6-4RDc-a078-99dRANDOMf).
Devoluciones
getCallRecording()
Inicializa una nueva instancia de CallRecording.
function getCallRecording(): CallRecording
Devoluciones
getSourceIdentity()
Obtención de la identidad de origen que se usa para la llamada de creación y respuesta
function getSourceIdentity(): undefined | CommunicationUserIdentifier
Devoluciones
undefined | CommunicationUserIdentifier
redirectCall(string, CallInvite, OperationOptions)
Redirija la llamada.
function redirectCall(incomingCallContext: string, targetParticipant: CallInvite, options?: OperationOptions): Promise<void>
Parámetros
- incomingCallContext
-
string
Contexto asociado a la llamada.
- targetParticipant
- CallInvite
Identidad de destino a la que se redirigirá la llamada.
- options
- OperationOptions
Las opciones de solicitud adicionales contienen las opciones de la API redirectCall.
Devoluciones
Promise<void>
rejectCall(string, RejectCallOptions)
Rechace la llamada.
function rejectCall(incomingCallContext: string, options?: RejectCallOptions): Promise<void>
Parámetros
- incomingCallContext
-
string
Contexto asociado a la llamada.
- options
- RejectCallOptions
Las opciones de solicitud adicionales contienen opciones de api rejectCall.
Devoluciones
Promise<void>