How to use Get External Contact action

[masanchezmemo]

Hello there,

We want to undestand the proper way to use Get External Contact action. One of its inputs is the External Contact ID but we don´t know where should we start in order to get that exernal contact ID value, it is confusing!!!

Regards,

Mario

[MelissaBailey]

Presumably you would know the id from doing a data dip, like using the Call Data Action.

If you don't know the id, use the Search External Contacts action instead. You can search using the phone number, email address or Twitter handle of the contact.

[Nathan_Tossens]

Hello,

I did a data action to get external contact info based on his phone number.

Here is the url to call :

/api/v2/externalcontacts/contacts/?q=${input.query}

Input contract is :

{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Get External Contact Request",
"description": "Get the external contact based on the query",
"type": "object",
"required": [
"query"
],
"properties": {
"query": {
"type": "string",
"description": "the Query"
}
}
}

Here is my response configuration :

{
"translationMap": {
"title": ".entities[0].title", "firstName": ".entities[0].lastName"
},
"translationMapDefaults": {
"title": """",
"firstName": """"
},
"successTemplate": "{\n "entities.title": {title}\n,\n \"entities.firstName\": {firstName}\n}"
}

Hope it helps

[wu_edward]

Hi,
Any documentation on the syntax of the query?

[tim.smith]

GET /api/v2/externalcontacts/contacts states:

User supplied search keywords (no special syntax is currently supported)