Skip to main content

Commands

Installation​

npm install @wildix/wda-stream-client

Commands​

GetOngoingCallCommand
Retrieves information for ongoing call. ### Allowed Auth Scopes - stream:GetOngoingCall - stream:read
GetOngoingCallAnnotationsCommand
Retrieves information and annotations for ongoing call. ### Allowed Auth Scopes - stream:GetOngoingCallAnnotations - stream:read
GetOngoingCallTranscriptionCommand
Retrieves information and transcription for ongoing call. ### Allowed Auth Scopes - stream:GetOngoingCallTranscription - stream:read
GetOngoingChatAnnotationsCommand
Retrieves information and annotations for ongoing chat. ### Allowed Auth Scopes - stream:GetOngoingChatAnnotations - stream:read
GetConferenceIdCommand
Retrieves ID for ongoing conference using a room token. ### Allowed Auth Scopes - stream:GetConferenceId - stream:read
GetOngoingConferenceCommand
Retrieves information for ongoing conference. ### Allowed Auth Scopes - stream:GetOngoingConference - stream:read
GetOngoingConferenceAnnotationsCommand
Retrieves information and annotations for ongoing conference. ### Allowed Auth Scopes - stream:GetOngoingConferenceAnnotations - stream:read
GetOngoingConferenceTranscriptionCommand
Retrieves information and transcription for ongoing conference. ### Allowed Auth Scopes - stream:GetOngoingConferenceTranscription - stream:read
QueryConversationsCommand
Retrieves ongoing conversations. Once the conversation ends the item would be dissapeared from the list. ### Allowed Auth Scopes - stream:QueryConversations - stream:read
ConsumeEventCommand
Consumes and processes stream events for calls, conferences, chats, SMS, WhatsApp, Messenger, RCS, and presence updates. ### Allowed Auth Scopes - stream:ConsumeEvent
DescribeEventCommand
QueryPresenceCommand
Retrieves the presence of a single user using specified query. If no presence information found for the query a PresenceNotAvailableException will be thrown. ### Allowed Auth Scopes - stream:QueryPresence - stream:read
QueryPresencesCommand
Retrieves users presences ### Allowed Auth Scopes - stream:QueryPresences - stream:read
UpdatePresenceLastSeenCommand
Updates the user's last seen presence information. ### Allowed Auth Scopes - stream:UpdatePresenceLastSeen
ListServicesCommand
Retrieves a list of active services of the company. ### Allowed Auth Scopes - stream:ListServices - stream:read
GetServiceStatsCommand
Retrieves live snapshot plus statistics for the requested lookback window. Period counters are cached for a few seconds, so they can be up to about 5 seconds older than the latest snapshot; calls, agents and the open occupancy interval are always current. Performance: cost grows with the number of ids times the number of buckets the lookback overlaps (1 Redis read per bucket without agentStats, 2 with it, plus a few per service). Without agentStats a request of 20 ids costs about 80 to 160 commands for 15 minutes to 1 hour and up to about 560 for 24 hours; with agentStats about 280 for 1 hour and up to about 600 for 12 or 24 hours (the id limit above keeps it there). The oldest bucket is usually only partly inside the lookback and is counted whole. ### Allowed Auth Scopes - stream:GetServiceStats - stream:read