Get participantID via Architect Directly

[agilio]

Is there a way to receive the participantID of the caller when they are in a In-Queue Flow without having to write a custom Data Action?

Thanks

Anthony

[crespino]

The underlying conversation model is not directly exposed within Architect, so you'll need to use a Data Action if you want to get to it and find the customer participant.

Architect does make some of the Customer properties available to you. What isn't there that you need?

[Jerome.Saint-Marc]

Hello,

No, at this time, you will have to call a custom Data Action to retrieve the customer's participantID.
The customer's participantID is not part of the available Architect built-in variables.

So you would have to either call the Data Action from the In-Queue flow.
Or call the Data Action from the Inbound Call flow, store the retrieved participantID as a custom participant attribute (from the same Inbound Call flow using "Set Participant Data"), and retrieve it from the In-Queue flow using "Get Participant Data".

Regards,

[agilio]

thank you!

Which API would you recommend I use?

[Jerome.Saint-Marc]

Hello,

As the ConversationID is available from the In-Queue flow as an Architect built-in variable, you could get the conversation with GET /api/v2/conversations/{conversationId}

In your Data Action, you could use a JSONPath expression to retrieve the participant structure that corresponds to the customer.
On an inbound call, the Response configuration of your Data Action would probably look like this:

{
  "translationMap": {
    "ParticipantIDArray": "$.participants[?(@.purpose ==\"customer\" || @.purpose ==\"external\")].id"
  },
  "translationMapDefaults": {
  },
  "successTemplate": "{\n   \"ParticipantID\": ${successTemplateUtils.firstFromArray(\"${ParticipantIDArray}\")}\n}"
}

Regards,