Get audio stream "424 Failed Dependency" error

[hoilo]

The getAudioStream function fails with a request and does not return a stream.

public getAudioStream(source: string, participantId: number) {
    return this.fetch!.get(
      '/callcontrol' + `/${source}` + '/participants' + `/${participantId}` + '/stream',
      {
        responseType: 'stream',
      },
    );
  }

I use the source and id that I get as part of the execution of the requestUpdatedEntityFromWebhookEventfunction

this.externalApiSvc
                        .requestUpdatedEntityFromWebhookEvent(wsEvent)
                        .then((res) => {
                            const participantData: CallParticipant = res.data;
                            this.updateParticipant(dn, parseFloat(id), participantData, wsEvent.event.entity);
                            console.log(chalk.green("📞 participantData:"), participantData);
                            /**
                             * handle here updated participants
                             */
                            const participant = this.getParticipantOfDnById(dn, parseFloat(id));
                            if (!participant || !this.externalApiSvc.connected) {
                                console.log(chalk.yellow(`participant not found by ${dn} ${parseFloat(id)}`));
                                return;
                            }

                            if (participantData.status === PARTICIPANT_STATUS_CONNECTED) {
                                //GET AUDIO STREAM HERE
                                const response = await this.externalApiSvc.getAudioStream(dn, participant.id!);
                            }

                        })
                        .catch((error) => {
                            console.error(chalk.red("❌ Error fetching participant data:"), error);
                        });

In the error text I see that dn and id are correct. The link was correct for receiving the stream.
In my case dn is the Extension number, not the application name. I specified in the settings of my API application which extension to use (the field Set extensions that are allowed for control and monitoring.).
I just need to record conversations to a file.

[kira565]

Hello @hoilo,

Unfortunately, media stream control is only available for RoutePoint DN types that are controlled by the application.
This is because RoutePoints are the primary special entities designed for extended programmatic call handling, and the private privileges of Extension types cannot be overridden.

The application does not have access to media control functions for private connections associated with additional DNs such as Extensions.

For any use cases requiring media control, please ensure that a RoutePoint DN is used.

I’ll update the documentation shortly to reflect this more clearly.

[hoilo]

Thank you very much for your answer.

Could you please suggest how I could solve the 403 problem elsewhere.

public async connect(connectConfig: ConnectAppRequest, appType: AppType) {
        try {
            console.log('connectConfig.appId', connectConfig.appId);
            if (
                !connectConfig.appId ||
                !connectConfig.appSecret ||
                !connectConfig.pbxBase ||
                appType !== AppType.Transcription // Adjust app type as needed
            ) {
                throw new Error("App Connection configuration is incorrect.");
            }
            await this.externalApiSvc.setup(connectConfig, appType);

            if (!this.externalApiSvc.wsClient) {
                throw new Error("WebSocket client is not initialized");
            }

            useWebsocketListeners(
                this.externalApiSvc.wsClient,
                this.wsEventHandler,
                this.onReconnectWs,
                this.externalApiSvc.restoreTries
            );

            const fullInfo = await this.externalApiSvc.getFullInfo();
            this.fullInfo = fullInfoToObject(fullInfo.data);
            console.log('fullInfo', this.fullInfo);
            const thesource: DnInfoModel | undefined = Array.from(
                this.fullInfo.callcontrol.values(),
            ).find((val) => val.type === 'Wroutepoint');

            if (!thesource) {
                throw new BadRequest(
                    'Application bound to the wrong dn, dn is not found or application hook is invalid, type should be Extension',
                );
            }

            console.log('thesource', thesource);
            this.sourceDn = thesource.dn ?? null;
            if (!this.sourceDn) {
                throw new BadRequest('Source DN is missing');
            }
            this.externalApiSvc.connected = true;

            console.log(chalk.green("✅ TranscriptionService connected successfully."));

            const userParams = {
                top: 50,
                skip: 0,
                orderby: 'LastName asc',
                select: ['Id', 'FirstName', 'LastName', 'Number', 'EmailAddress'],
                expand: ['Groups(Rights)'],
            };

            let res = await this.externalApiSvc.getUsers(userParams);


        } catch (error) {
            this.externalApiSvc.disconnect();
            throw error;
        }
    }

public async getUsers(params: {
    top?: number;
    skip?: number;
    orderby?: string;
    select?: string[];
    expand?: string[];
  }): Promise<any> {
    if (!this.fetch) {
      throw new Error('API instance not init!');
    }

    try {
      const response = await this.fetch.get('/xapi/v1/Users', {
        params: {
          $top: params?.top ?? 100,
          $skip: params?.skip ?? 0,
          $orderby: params?.orderby ?? 'Number',
          $select: params?.select?.join(',') ?? 'Id,FirstName,LastName,Number,EmailAddress',
          $expand: params?.expand?.join(',') ?? 'Groups(Rights)',
        },
      });

      console.log('Users:', response.data);
      return response.data;
    } catch (error) {
      console.error('Error /xapi/v1/Users:', error);
      throw error;
    }
  }

I'm trying to get a list of users using the same token that I used to connect to a socket and get participant information. getUsers returns a 403 error.
Please tell me what the problem might be, thanks.

[sherlock1982]

You absolutely can and should use the same access token.
Here's a checklist for you:

1. XAPI access checkbox is enabled for the app you're using

2. Role for the app is NOT set to a User or Receptionist. As these roles can't control other users (and therefore can't list them)
   Select some group and set role to "System Owner" for example to access all users. Group should be selected for the app to have any role except User.
   Starting from "Group Owner" roles will be able to access only users in selected group

3. If that doesn't help make sure that header is
   Authorization: Bearer and not just Authorization:
   You can also post here token contents (except signature. you can unpack token using jwt.io) so I can check it. Basically you can check youself if the role "Users" is there
   And/or enable trace logging and give me some log messages around your users request

We have a different project for this just in case:
https://github.com/3cx/xapi-tutorial

[Scriptkiddi]

@kira565 I was wondering if there is someway we could override that security framework. We want to implement our own transcription service for data privacy reasons. Or is there another way we could do that?

[sherlock1982]

@Scriptkiddi you can download recordings so I don't see why not. Most probably you can't push back transcriptions. So for that you will need access to DB and therefor your service should run on the PBX
If you run on the PBX you can simply (periodically) scan non-transcribed recordings, transcribe them and push back to the PBX.

You can as well offload recordings to external storage and process them there

[Scriptkiddi]

I would prefer to just work with the media stream from the extension. Creating recording even if i delete them right away is a trust issue problem for employees and customers. If the stream is never saved and just transcribed and then summerized its a lot easier.
So is there someway to get the media stream from a private extension?

[sherlock1982]

There's a way but not an easy one. In short: you have to write your own MyPhone+WebRTC client. Imitate Webclient in some sense.

Starting from SP8 you will be able to impersonate MyPhone via Service Principal. For now you have to login via Username/Password (the way like Webclient works)
Now when there's an interesting call you should BargeIn into that call and via WebRTC receive a stream.
I wrote something similar currently in Python (but without barge in) using aiortc library (but it needs a small patch to connect to PBX)

But it's not an easy example to do honestly

[kira565]

@Scriptkiddi unfortunately besides Recordings there is no official way to do it now.

However, if the customer independently implements a solution using a SIP device that supports UACSTA (or similar call control mechanisms), and has the necessary administrative permissions within their PBX, they can configure such a system:

1 An extension with a device with the appropriate permissions (e.g., barge-in, listen-in) connects to the call.
2 The audio stream from this device is then sent to a third-party transcription service.

In this case, the responsibility for implementation and compliance with privacy and security policies lies entirely with the customer or their organization.

[Scriptkiddi]

thanks for the info. Which api can be used to trigger a listen in?

[sherlock1982]

MyPhone. You can check Webclient. Simply sey "wc.logger=true" in local storage, F5 and see what it sends in which case. Imitate barge in.
But again that's the smallest issue here

[hoilo]

You absolutely can and should use the same access token. Here's a checklist for you:

1. XAPI access checkbox is enabled for the app you're using
2. Role for the app is NOT set to a User or Receptionist. As these roles can't control other users (and therefore can't list them)
   Select some group and set role to "System Owner" for example to access all users. Group should be selected for the app to have any role except User.
   Starting from "Group Owner" roles will be able to access only users in selected group
3. If that doesn't help make sure that header is
   Authorization: Bearer and not just Authorization:
   You can also post here token contents (except signature. you can unpack token using jwt.io) so I can check it. Basically you can check youself if the role "Users" is there
   And/or enable trace logging and give me some log messages around your users request

We have a different project for this just in case: https://github.com/3cx/xapi-tutorial

Thanks for the answer. I figured out the token.
But I have one more question.
I get a list of records with transcription as the web client does

public async getRecordings(params: {
    top?: number;
    skip?: number;
    orderby?: string;
    select?: string[];
    filter?: string;
    expand?: string[];
    count?: boolean;
  }): Promise<any> {
    if (!this.fetch) {
      throw new Error('API instance is not initialized. Call setup() first.');
    }

    try {
      const response = await this.fetch.get('/xapi/v1/Recordings', {
        params: {
          $top: params?.top,
          $skip: params?.skip,
          $orderby: params?.orderby,
          $select: params?.select?.join(','),
          $filter: params?.filter,
          $expand: params?.expand?.join(','),
          $count: params?.count,
        },
      });
      return response.data;
    } catch (error) {
      console.error('Error API /Recordings:', error);
      throw error;
    }
  }

const params = {
                top: 50,
                skip: 0,
                orderby: 'StartTime desc',
                select: [
                    'Id',
                    'IsArchived',
                    'Transcription',
                    'FromDidNumber',
                    'FromDn',
                    'FromCallerNumber',
                    'FromDisplayName',
                    'StartTime',
                    'ToDnType',
                    'ToDidNumber',
                    'ToDisplayName',
                    'ToDn',
                    'SentimentScore',
                    'Summary',
                    'FromIdParticipant',
                    'RefParticipantId',
                    'ToIdParticipant',
                    'RecordingUrl',
                    'ToCrmContact',

                ],
                filter: '(StartTime ge 2025-07-08T01:00:00.000Z and StartTime lt 2025-07-08T22:00:00.000Z)',
                count: true,
            };

            const recordings = await this.externalApiSvc.getRecordings(params);

However, the received Id, FromIdParticipant, ToIdParticipant does not match what requestUpdatedEntityFromWebhookEvent (Participant id) returns.

How can I link this data to know that this particular table row is related to this call.
Thank you.